Class: RemoteMCPClient
Defined in: packages/mcp/src/remote-client.ts:49
Extended by
Constructors
Constructor
new RemoteMCPClient(
config,options?):RemoteMCPClient
Defined in: packages/mcp/src/remote-client.ts:64
Parameters
config
options?
MCPClientOptions = {}
Returns
RemoteMCPClient
Properties
protocolClient
protectedprotocolClient:MCPProtocolClient
Defined in: packages/mcp/src/remote-client.ts:51
Methods
beforeClose()
protectedbeforeClose(_transport):void
Defined in: packages/mcp/src/remote-client.ts:374
Called with a transport this client built, before it is closed, so a spawned process can be signalled at once.
Parameters
_transport
Returns
void
callTool()
callTool(
name,args?,options?):Promise<MCPToolResult>
Defined in: packages/mcp/src/remote-client.ts:265
Parameters
name
string
args?
Record<string, unknown>
options?
Returns
Promise<MCPToolResult>
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>
connectWithTransport()
connectWithTransport(
transport):Promise<void>
Defined in: packages/mcp/src/remote-client.ts:141
Parameters
transport
MCPTransport | RemoteMCPTransportConfig
Returns
Promise<void>
createStdioTransport()
protectedcreateStdioTransport(_config,_verbose):MCPTransport
Defined in: packages/mcp/src/remote-client.ts:369
Stdio needs a child process; MCPClient (in client.ts) provides it.
Parameters
_config
_verbose
boolean
Returns
disconnect()
disconnect():
Promise<void>
Defined in: packages/mcp/src/remote-client.ts:201
Returns
Promise<void>
getAiSdkClient()
getAiSdkClient():
MCPClient
Defined in: packages/mcp/src/remote-client.ts:104
Returns
MCPClient
getName()
getName():
string
Defined in: packages/mcp/src/remote-client.ts:80
Returns
string
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[]>
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
getStatus()
getStatus():
MCPConnectionStatus
Defined in: packages/mcp/src/remote-client.ts:88
Returns
getToolPrefix()
getToolPrefix():
string|undefined
Defined in: packages/mcp/src/remote-client.ts:84
Returns
string | undefined
isConnected()
isConnected():
boolean
Defined in: packages/mcp/src/remote-client.ts:92
Returns
boolean
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?
Returns
Promise<MCPSubscription>
listPrompts()
listPrompts():
Promise<MCPPrompt[]>
Defined in: packages/mcp/src/remote-client.ts:328
Returns
Promise<MCPPrompt[]>
listResources()
listResources():
Promise<MCPResource[]>
Defined in: packages/mcp/src/remote-client.ts:289
Returns
Promise<MCPResource[]>
listResourceTemplates()
listResourceTemplates():
Promise<MCPResourceTemplate[]>
Defined in: packages/mcp/src/remote-client.ts:299
Returns
Promise<MCPResourceTemplate[]>
listTools()
listTools(
options?):Promise<MCPTool[]>
Defined in: packages/mcp/src/remote-client.ts:255
Parameters
options?
Returns
Promise<MCPTool[]>
readResource()
readResource(
uri):Promise<MCPResourceContent>
Defined in: packages/mcp/src/remote-client.ts:309
Parameters
uri
string
Returns
Promise<MCPResourceContent>