Skip to content

MCPServerStreamableHttp

Extended MCP server surface for servers that expose resources.

  • BaseMCPServerStreamableHttp
new MCPServerStreamableHttp(options): MCPServerStreamableHttp;
Parameter Type

options

MCPServerStreamableHttpOptions

MCPServerStreamableHttp

BaseMCPServerStreamableHttp.constructor

cacheToolsList: boolean;

MCPServerWithResources.cacheToolsList

BaseMCPServerStreamableHttp.cacheToolsList


customDataExtractor?: MCPToolCustomDataExtractor;

MCPServerWithResources.customDataExtractor

BaseMCPServerStreamableHttp.customDataExtractor


errorFunction?:
| MCPToolErrorFunction
| null;

Optional function to convert MCP tool failures into model-visible messages. Set to null to rethrow errors instead of converting them.

MCPServerWithResources.errorFunction

BaseMCPServerStreamableHttp.errorFunction


toolFilter?:
| MCPToolFilterStatic
| MCPToolFilterCallable;

MCPServerWithResources.toolFilter

BaseMCPServerStreamableHttp.toolFilter


toolInputGuardrails?: ToolInputGuardrailDefinition<any>[];

Guardrails applied before every tool on this server is invoked.

MCPServerWithResources.toolInputGuardrails

BaseMCPServerStreamableHttp.toolInputGuardrails


toolMetaResolver?: MCPToolMetaResolver;

MCPServerWithResources.toolMetaResolver

BaseMCPServerStreamableHttp.toolMetaResolver


toolOutputGuardrails?: ToolOutputGuardrailDefinition<any>[];

Guardrails applied after every tool on this server returns.

MCPServerWithResources.toolOutputGuardrails

BaseMCPServerStreamableHttp.toolOutputGuardrails


useStructuredContent?: boolean;

Whether to use MCP structuredContent as the model-visible tool output when available. Defaults to false to preserve the existing content-based output behavior.

MCPServerWithResources.useStructuredContent

BaseMCPServerStreamableHttp.useStructuredContent

get name(): string;

string

MCPServerWithResources.name

BaseMCPServerStreamableHttp.name


get sessionId(): string | undefined;

string | undefined

BaseMCPServerStreamableHttp.sessionId

callTool(
toolName,
args,
meta?,
options?
): Promise<CallToolResultContent>;
Parameter Type

toolName

string

args

Record<string, unknown> | null

meta?

Record<string, unknown> | null

options?

MCPCallToolOptions

Promise<CallToolResultContent>

MCPServerWithResources.callTool

BaseMCPServerStreamableHttp.callTool


callToolResult(
toolName,
args,
meta?,
options?
): Promise<{
_meta?: Record<string, unknown>;
content: object[];
isError?: boolean;
structuredContent?: Record<string, unknown>;
}>;

Invoke a tool and return the full serializable MCP result.

Parameter Type

toolName

string

args

Record<string, unknown> | null

meta?

Record<string, unknown> | null

options?

MCPCallToolOptions

Promise<{ _meta?: Record<string, unknown>; content: object[]; isError?: boolean; structuredContent?: Record<string, unknown>; }>

MCPServerWithResources.callToolResult

BaseMCPServerStreamableHttp.callToolResult


close(): Promise<void>;

Promise<void>

MCPServerWithResources.close

BaseMCPServerStreamableHttp.close


connect(): Promise<void>;

Promise<void>

MCPServerWithResources.connect

BaseMCPServerStreamableHttp.connect


invalidateToolsCache(): Promise<void>;

Promise<void>

MCPServerWithResources.invalidateToolsCache

BaseMCPServerStreamableHttp.invalidateToolsCache


listResources(params?): Promise<MCPListResourcesResult>;
Parameter Type

params?

MCPListResourcesParams

Promise<MCPListResourcesResult>

MCPServerWithResources.listResources

BaseMCPServerStreamableHttp.listResources


listResourceTemplates(params?): Promise<MCPListResourceTemplatesResult>;
Parameter Type

params?

MCPListResourcesParams

Promise<MCPListResourceTemplatesResult>

MCPServerWithResources.listResourceTemplates

BaseMCPServerStreamableHttp.listResourceTemplates


listTools(): Promise<object[]>;

Promise<object[]>

MCPServerWithResources.listTools

BaseMCPServerStreamableHttp.listTools


readResource(uri): Promise<MCPReadResourceResult>;
Parameter Type

uri

string

Promise<MCPReadResourceResult>

MCPServerWithResources.readResource

BaseMCPServerStreamableHttp.readResource