AxMCPClientOptions Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxMCPClientOptions.md interface AxMCPClientOptions

AxMCPClientOptions

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L114

Properties

PropertyTypeDescription
authorizeToolCall?(call: Readonly<{ arguments: unknown; client: AxMCPClient; namespace: string; tool: AxMCPTool; }>) => undefined | boolean | Promise<undefined | boolean>Host policy hook invoked before an MCP tool is called.
capabilities?AxMCPClientCapabilitiesExtra client capabilities to advertise. Advertise only implemented ones.
clientInfo?Partial<AxMCPImplementationInfo>Client metadata sent in initialize.
debug?booleanEnable debug logging
elicitation?(params: Readonly<AxMCPElicitationCreateParams>, context: Readonly<{ client: AxMCPClient; namespace: string; }>) => | AxMCPElicitationCreateResult | Promise<AxMCPElicitationCreateResult>Handles server-initiated elicitation/create requests.
extensions?Record<string, AxMCPExtensionCapability>Optional MCP extensions advertised during initialize.
functionOverrides?AxMCPFunctionOverride[]List of function overrides for tool/prompt/resource wrappers.
logger?AxLoggerFunctionLogger function for debug output
maxConcurrency?numberMaximum concurrent tool or task-augmented tool calls for this server.
maxPaginationPages?numberMaximum pages accepted from any single catalog listing.
namespace?stringStable namespace used when this client is attached to Ax programs.
onLoggingMessage?(params: Readonly<Record<string, unknown>>) => void | Promise<void>-
onNotification?(notification: Readonly<AxMCPJSONRPCNotification>) => void | Promise<void>Generic notification callback for all server notifications.
onProgress?(params: Readonly<AxMCPProgressNotificationParams>) => void | Promise<void>-
onPromptsChanged?() => void | Promise<void>-
onResourcesChanged?() => void | Promise<void>-
onResourceUpdated?(uri: string) => void | Promise<void>-
onTaskStatus?(task: Readonly<AxMCPTask>) => void | Promise<void>-
onToolsChanged?() => void | Promise<void>-
protocolVersion?stringMCP protocol version to request during initialize. Defaults to latest.
roots?readonly AxMCPRoot[]Optional roots support. When set, Ax advertises and answers roots/list.
sampling?(params: Readonly<AxMCPSamplingCreateMessageParams>, context: Readonly<{ client: AxMCPClient; namespace: string; }>) => | AxMCPSamplingCreateMessageResult | Promise<AxMCPSamplingCreateMessageResult>Handles server-initiated sampling/createMessage requests.
sessionRecovery?"none" | "safe"Reinitialize expired HTTP sessions for safe requests. Defaults to safe.
supportedProtocolVersions?readonly string[]Protocol versions this client can accept during negotiation.
tracer?TracerOptional protocol tracer; request spans contain sanitized MCP metadata.
Docs