Skip to main content

Class: MCPClient

Defined in: packages/mcp/src/client.ts:15

Extends​

Constructors​

Constructor​

new MCPClient(config, options?): MCPClient

Defined in: packages/mcp/src/remote-client.ts:64

Parameters​

config​

MCPServerConfig

options?​

MCPClientOptions = {}

Returns​

MCPClient

Inherited from​

RemoteMCPClient.constructor

Properties​

protocolClient​

protected protocolClient: MCPProtocolClient

Defined in: packages/mcp/src/remote-client.ts:51

Inherited from​

RemoteMCPClient.protocolClient

Methods​

beforeClose()​

protected beforeClose(transport): void

Defined in: packages/mcp/src/client.ts:52

The SDK's graceful close waits before signalling. A process 'exit' handler cannot run those continuations, so signal the child's PID first.

Parameters​

transport​

MCPTransport

Returns​

void

Overrides​

RemoteMCPClient.beforeClose


callTool()​

callTool(name, args?, options?): Promise<MCPToolResult>

Defined in: packages/mcp/src/remote-client.ts:265

Parameters​

name​

string

args?​

Record<string, unknown>

options?​

MCPCallOptions

Returns​

Promise<MCPToolResult>

Inherited from​

RemoteMCPClient.callTool


connect()​

connect(options?): Promise<void>

Defined in: packages/mcp/src/remote-client.ts:114

signal abandons a handshake still in flight.

Parameters​

options?​
signal?​

AbortSignal

Returns​

Promise<void>

Inherited from​

RemoteMCPClient.connect


connectWithTransport()​

connectWithTransport(transport): Promise<void>

Defined in: packages/mcp/src/remote-client.ts:141

Parameters​

transport​

MCPTransport | RemoteMCPTransportConfig

Returns​

Promise<void>

Inherited from​

RemoteMCPClient.connectWithTransport


createStdioTransport()​

protected createStdioTransport(transport, verbose): MCPTransport

Defined in: packages/mcp/src/client.ts:22

Stdio needs a child process; MCPClient (in client.ts) provides it.

Parameters​

transport​

StdioTransportConfig

verbose​

boolean

Returns​

MCPTransport

Overrides​

RemoteMCPClient.createStdioTransport


disconnect()​

disconnect(): Promise<void>

Defined in: packages/mcp/src/remote-client.ts:201

Returns​

Promise<void>

Inherited from​

RemoteMCPClient.disconnect


getAiSdkClient()​

getAiSdkClient(): MCPClient

Defined in: packages/mcp/src/remote-client.ts:104

Returns​

MCPClient

Inherited from​

RemoteMCPClient.getAiSdkClient


getEvents()​

getEvents(): MCPEvents

Defined in: packages/mcp/src/client.ts:17

Experimental Triggers & Events draft 6682596d, on the existing connection.

Returns​

MCPEvents


getName()​

getName(): string

Defined in: packages/mcp/src/remote-client.ts:80

Returns​

string

Inherited from​

RemoteMCPClient.getName


getPrompt()​

getPrompt(name, args?): Promise<MCPPromptMessage[]>

Defined in: packages/mcp/src/remote-client.ts:341

Parameters​

name​

string

args?​

Record<string, string>

Returns​

Promise<MCPPromptMessage[]>

Inherited from​

RemoteMCPClient.getPrompt


getProtocolClient()​

getProtocolClient(): Client

Defined in: packages/mcp/src/remote-client.ts:97

Configure handlers before connecting; preserve full protocol results through this typed SDK.

Returns​

Client

Inherited from​

RemoteMCPClient.getProtocolClient


getStatus()​

getStatus(): MCPConnectionStatus

Defined in: packages/mcp/src/remote-client.ts:88

Returns​

MCPConnectionStatus

Inherited from​

RemoteMCPClient.getStatus


getToolPrefix()​

getToolPrefix(): string | undefined

Defined in: packages/mcp/src/remote-client.ts:84

Returns​

string | undefined

Inherited from​

RemoteMCPClient.getToolPrefix


isConnected()​

isConnected(): boolean

Defined in: packages/mcp/src/remote-client.ts:92

Returns​

boolean

Inherited from​

RemoteMCPClient.isConnected


listen()​

listen(filter, options?): Promise<MCPSubscription>

Defined in: packages/mcp/src/remote-client.ts:99

Parameters​

filter​
promptsListChanged?​

boolean

resourcesListChanged?​

boolean

resourceSubscriptions?​

string[]

toolsListChanged?​

boolean

options?​

MCPRequestOptions

Returns​

Promise<MCPSubscription>

Inherited from​

RemoteMCPClient.listen


listPrompts()​

listPrompts(): Promise<MCPPrompt[]>

Defined in: packages/mcp/src/remote-client.ts:328

Returns​

Promise<MCPPrompt[]>

Inherited from​

RemoteMCPClient.listPrompts


listResources()​

listResources(): Promise<MCPResource[]>

Defined in: packages/mcp/src/remote-client.ts:289

Returns​

Promise<MCPResource[]>

Inherited from​

RemoteMCPClient.listResources


listResourceTemplates()​

listResourceTemplates(): Promise<MCPResourceTemplate[]>

Defined in: packages/mcp/src/remote-client.ts:299

Returns​

Promise<MCPResourceTemplate[]>

Inherited from​

RemoteMCPClient.listResourceTemplates


listTools()​

listTools(options?): Promise<MCPTool[]>

Defined in: packages/mcp/src/remote-client.ts:255

Parameters​

options?​

MCPCallOptions

Returns​

Promise<MCPTool[]>

Inherited from​

RemoteMCPClient.listTools


readResource()​

readResource(uri): Promise<MCPResourceContent>

Defined in: packages/mcp/src/remote-client.ts:309

Parameters​

uri​

string

Returns​

Promise<MCPResourceContent>

Inherited from​

RemoteMCPClient.readResource