Documentation / @agentick/mcp / MCPClientOptions
Interface: MCPClientOptions
Defined in: client/types.ts:240
Properties
circuitBreaker?
optionalcircuitBreaker:object
Defined in: client/types.ts:276
Circuit breaker for consistently failing servers.
failureThreshold?
optionalfailureThreshold:number
Consecutive failures before opening the circuit. Default: 5.
resetTimeoutMs?
optionalresetTimeoutMs:number
Time in ms to keep circuit open before allowing a probe. Default: 30000.
elicitationHandler?
optionalelicitationHandler:ElicitationHandler
Defined in: client/types.ts:255
Handler for server-initiated elicitation requests (form mode and URL mode per MCP spec 2025-11-25). Returning { action: "accept", content } delivers the user's input back to the server; decline and cancel are propagated as distinct outcomes. Omit either mode in elicitationModes to opt out of advertising the corresponding sub-capability.
elicitationModes?
optionalelicitationModes: ("url"|"form")[]
Defined in: client/types.ts:261
Which elicitation modes to advertise. Default: ["form", "url"] when elicitationHandler is set; ignored otherwise. Set to a subset to opt out of one mode.
logHandler?
optionallogHandler:LogHandler
Defined in: client/types.ts:265
Handler for server log messages.
mcpApps?
optionalmcpApps:boolean
Defined in: client/types.ts:272
Advertise the io.modelcontextprotocol/ui extension during initialization so spec-compliant servers emit MCP Apps metadata. Default: true. Set to false for headless clients that will never render ui:// resources — strict servers may then downgrade to text-only tool registration.
name?
optionalname:string
Defined in: client/types.ts:242
Client name sent during initialization.
roots?
optionalroots:Root[]
Defined in: client/types.ts:263
Filesystem roots to provide to servers on request.
samplingHandler?
optionalsamplingHandler:SamplingHandler
Defined in: client/types.ts:246
Handler for server-initiated sampling (createMessage) requests.
toolCallTimeoutMs?
optionaltoolCallTimeoutMs:number
Defined in: client/types.ts:274
Default timeout in milliseconds for tool calls. Default: 60000 (60s).
version?
optionalversion:string
Defined in: client/types.ts:244
Client version sent during initialization.