McpClientOptions
Defined in: src/mcp/client.ts:254
Behavioral options shared by all MCP client configurations.
Extends
Section titled “Extends”RuntimeConfig
Properties
Section titled “Properties”applicationName?
Section titled “applicationName?”applicationName?: string;Defined in: src/mcp/client.ts:81
Inherited from
Section titled “Inherited from”RuntimeConfig.applicationName
applicationVersion?
Section titled “applicationVersion?”applicationVersion?: string;Defined in: src/mcp/client.ts:82
Inherited from
Section titled “Inherited from”RuntimeConfig.applicationVersion
disableMcpInstrumentation?
Section titled “disableMcpInstrumentation?”disableMcpInstrumentation?: boolean;Defined in: src/mcp/client.ts:256
Disable OpenTelemetry MCP instrumentation.
prefix?
Section titled “prefix?”prefix?: string;Defined in: src/mcp/client.ts:259
Prefix for agent-facing tool names, applied as <prefix>_<toolName>.
toolFilters?
Section titled “toolFilters?”toolFilters?: McpToolFilters;Defined in: src/mcp/client.ts:262
Filters controlling which tools this client exposes.
tasksConfig?
Section titled “tasksConfig?”tasksConfig?: TasksConfig;Defined in: src/mcp/client.ts:265
Enables automatic execution for legacy task tools. Experimental: subject to change.
listMaxPages?
Section titled “listMaxPages?”listMaxPages?: number;Defined in: src/mcp/client.ts:268
Page cap for the no-token list methods, which aggregate every page. 0 disables the cap. Defaults to the MCP client’s 64.
progressCallback?
Section titled “progressCallback?”progressCallback?: McpProgressCallback;Defined in: src/mcp/client.ts:276
Callback for progress notifications during tool calls, including calls an agent makes.
Not delivered for calls the server runs as a task (tasksConfig with a task-capable
server). The total and message fields may be absent when the server does not provide
them. A per-call progressCallback takes precedence.
elicitationCallback?
Section titled “elicitationCallback?”elicitationCallback?: ElicitationCallback;Defined in: src/mcp/client.ts:283
Callback to handle server-initiated elicitation requests. When provided, the client advertises elicitation support (form + url modes) and routes incoming elicitation requests to this callback.
continueOnError?
Section titled “continueOnError?”continueOnError?: boolean;Defined in: src/mcp/client.ts:286
When true, connection failures and overlong prefixed names during tool listing are skipped with warnings.
logHandler?
Section titled “logHandler?”logHandler?: (params) => void;Defined in: src/mcp/client.ts:289
Called when the server emits a log message. Defaults to routing through the Strands logger.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
params | LoggingMessageNotificationParams |
Returns
Section titled “Returns”void