Skip to main content

Class: MCPClient

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

Constructors​

Constructor​

new MCPClient(config, options?): MCPClient

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

Parameters​

config​

MCPServerConfig

options?​

MCPClientOptions = {}

Returns​

MCPClient

Methods​

callTool()​

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

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

Parameters​

name​

string

args?​

Record<string, unknown>

Returns​

Promise<MCPToolResult>

connect()​

connect(): Promise<void>

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

Returns​

Promise<void>

connectWithTransport()​

connectWithTransport(transport): Promise<void>

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

Parameters​

transport​

RemoteMCPTransportConfig | MCPTransport

Returns​

Promise<void>

disconnect()​

disconnect(): Promise<void>

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

Returns​

Promise<void>

getAiSdkClient()​

getAiSdkClient(): MCPClient

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

Returns​

MCPClient

getName()​

getName(): string

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

Returns​

string

getPrompt()​

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

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

Parameters​

name​

string

args?​

Record<string, string>

Returns​

Promise<MCPPromptMessage[]>

getStatus()​

getStatus(): MCPConnectionStatus

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

Returns​

MCPConnectionStatus

getToolPrefix()​

getToolPrefix(): string | undefined

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

Returns​

string | undefined

isConnected()​

isConnected(): boolean

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

Returns​

boolean

listPrompts()​

listPrompts(): Promise<MCPPrompt[]>

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

Returns​

Promise<MCPPrompt[]>

listResources()​

listResources(): Promise<MCPResource[]>

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

Returns​

Promise<MCPResource[]>

listResourceTemplates()​

listResourceTemplates(): Promise<MCPResourceTemplate[]>

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

Returns​

Promise<MCPResourceTemplate[]>

listTools()​

listTools(): Promise<MCPTool[]>

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

Returns​

Promise<MCPTool[]>

readResource()​

readResource(uri): Promise<MCPResourceContent>

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

Parameters​

uri​

string

Returns​

Promise<MCPResourceContent>