Class McpClient

capabilities

OptionalserverInfo

call

• call(method: string, params?: unknown): Promise<any>

  Any JSON-RPC method; the raw result. A JSON-RPC error becomes an AIError with code MCP_ERROR and providerCode set to the RPC code.

  Parameters

  • method: string
  • Optionalparams: unknown

  Returns Promise<any>

callTool

• callTool(name: string, args?: unknown): Promise<string>

  tools/call, flattened: text items joined by newlines, anything else as JSON. A result marked isError throws so the model sees { error }.

  Parameters

  • name: string
  • args: unknown = {}

  Returns Promise<string>

close

• close(): Promise<void>

  Returns Promise<void>

getPrompt

• getPrompt(
      name: string,
      args?: Record<string, string>,
  ): Promise<
      {
          description?: string;
          messages: { content: McpContent; role: string }[];
      },
  >

  Parameters

  • name: string
  • Optionalargs: Record<string, string>

  Returns Promise<
      {
          description?: string;
          messages: { content: McpContent; role: string }[];
      },
  >

listTools

• listTools(): Promise<McpTool[]>

  The server's tools, paginated to the end.

  Returns Promise<McpTool[]>

ping

• ping(): Promise<void>

  Returns Promise<void>

prompts

• prompts(): Promise<McpPrompt[]>

  Returns Promise<McpPrompt[]>

readResource

• readResource(uri: string): Promise<McpContent[]>

  Parameters

  • uri: string

  Returns Promise<McpContent[]>

resources

• resources(): Promise<McpResource[]>

  Returns Promise<McpResource[]>

tools

• tools(): Promise<Tool[]>

  The server's tools as Tool[]: the server's own JSON Schema, and an execute that calls tools/call and flattens the result to text.

  Returns Promise<Tool[]>

Staticconnect

• connect(options: McpConnectOptions): Promise<McpClient>

  Connects and runs the initialize handshake. Pass url for Streamable HTTP, or transport (e.g. from ./mcp-stdio).

  Parameters

  • options: McpConnectOptions

  Returns Promise<McpClient>