Class McpClient

MCP Client for interacting with Model Context Protocol servers.

Index

Constructors

Accessors

Methods

connect disconnect listTools callTool

Constructors

constructor

new McpClient(args: McpClientConfig): McpClient
Parameters
- args: McpClientConfig
Returns McpClient
- Defined in sdk-typescript/src/mcp.ts:23

Accessors

client

get client(): Client
Returns Client
- Defined in sdk-typescript/src/mcp.ts:34

Methods

connect

connect(reconnect?: boolean): Promise<void>
Connects the MCP client to the server.

This function is exposed to allow consumers to connect manually, but will be called lazily before any operations that require a connection.
Parameters
- reconnect: boolean = false
Returns Promise<void>
A promise that resolves when the connection is established.
- Defined in sdk-typescript/src/mcp.ts:45

disconnect

disconnect(): Promise<void>
Disconnects the MCP client from the server and cleans up resources.

Returns Promise<void>
A promise that resolves when the disconnection is complete.
- Defined in sdk-typescript/src/mcp.ts:65

listTools

listTools(): Promise<McpTool[]>
Lists the tools available on the server and returns them as executable McpTool instances.

Returns Promise<McpTool[]>
A promise that resolves with an array of McpTool instances.
- Defined in sdk-typescript/src/mcp.ts:77

callTool

callTool(tool: McpTool, args: JSONValue): Promise<JSONValue>
Invoke a tool on the connected MCP server using an McpTool instance.
Parameters
- tool: McpTool
  The McpTool instance to invoke.
- args: JSONValue
  The arguments to pass to the tool.
Returns Promise<JSONValue>
A promise that resolves with the result of the tool invocation.
- Defined in sdk-typescript/src/mcp.ts:99