Skip to content

MCPServerStdio

Public interface of an MCP server that provides tools. You can use this class to pass MCP server settings to your agent.

  • BaseMCPServerStdio
new MCPServerStdio(options): MCPServerStdio;
Parameter Type

options

MCPServerStdioOptions

MCPServerStdio

BaseMCPServerStdio.constructor

cacheToolsList: boolean;

MCPServerWithResources.cacheToolsList

BaseMCPServerStdio.cacheToolsList


customDataExtractor?: MCPToolCustomDataExtractor;

MCPServerWithResources.customDataExtractor

BaseMCPServerStdio.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

BaseMCPServerStdio.errorFunction


toolFilter?:
| MCPToolFilterCallable
| MCPToolFilterStatic;

MCPServerWithResources.toolFilter

BaseMCPServerStdio.toolFilter


toolInputGuardrails?: ToolInputGuardrailDefinition<any>[];

Guardrails applied before every tool on this server is invoked.

MCPServerWithResources.toolInputGuardrails

BaseMCPServerStdio.toolInputGuardrails


toolMetaResolver?: MCPToolMetaResolver;

MCPServerWithResources.toolMetaResolver

BaseMCPServerStdio.toolMetaResolver


toolOutputGuardrails?: ToolOutputGuardrailDefinition<any>[];

Guardrails applied after every tool on this server returns.

MCPServerWithResources.toolOutputGuardrails

BaseMCPServerStdio.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

BaseMCPServerStdio.useStructuredContent

get name(): string;

string

MCPServerWithResources.name

BaseMCPServerStdio.name

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

BaseMCPServerStdio.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

BaseMCPServerStdio.callToolResult


close(): Promise<void>;

Promise<void>

MCPServerWithResources.close

BaseMCPServerStdio.close


connect(): Promise<void>;

Promise<void>

MCPServerWithResources.connect

BaseMCPServerStdio.connect


invalidateToolsCache(): Promise<void>;

Promise<void>

MCPServerWithResources.invalidateToolsCache

BaseMCPServerStdio.invalidateToolsCache


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

params?

MCPListResourcesParams

Promise<MCPListResourcesResult>

MCPServerWithResources.listResources

BaseMCPServerStdio.listResources


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

params?

MCPListResourcesParams

Promise<MCPListResourceTemplatesResult>

MCPServerWithResources.listResourceTemplates

BaseMCPServerStdio.listResourceTemplates


listTools(): Promise<object[]>;

Promise<object[]>

MCPServerWithResources.listTools

BaseMCPServerStdio.listTools


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

uri

string

Promise<MCPReadResourceResult>

MCPServerWithResources.readResource

BaseMCPServerStdio.readResource