Documentation / @agentick/core / MCPClient

Class: MCPClient

Defined in: mcp/src/client/client.ts:121

Constructors

Constructor

new MCPClient(options?): MCPClient

Defined in: mcp/src/client/client.ts:133

Parameters

options?

MCPClientOptions

Returns

MCPClient

Methods

callTool()

callTool(serverName, toolName, input, options?): Promise<any>

Defined in: mcp/src/client/client.ts:424

Parameters

serverName

string

toolName

string

input

Record<string, unknown>

options?

onProgress?

ProgressCallback

signal?

AbortSignal

timeoutMs?

number

Returns

Promise<any>

completePromptArgument()

completePromptArgument(serverName, promptName, argumentName, value): Promise<string[]>

Defined in: mcp/src/client/client.ts:690

Request argument completions for a prompt. MCP spec supports completions for ref/prompt and ref/resource.

Parameters

serverName

string

promptName

string

argumentName

string

value

string

Returns

Promise<string[]>

completeResourceTemplate()

completeResourceTemplate(serverName, uriTemplate, argumentName, value): Promise<string[]>

Defined in: mcp/src/client/client.ts:707

Request argument completions for a resource template variable.

Parameters

serverName

string

uriTemplate

string

argumentName

string

value

string

Returns

Promise<string[]>

connect()

connect(config): Promise<void>

Defined in: mcp/src/client/client.ts:145

Parameters

config

MCPConnectionConfig

Returns

Promise<void>

disconnect()

disconnect(serverName): Promise<void>

Defined in: mcp/src/client/client.ts:299

Parameters

serverName

string

Returns

Promise<void>

disconnectAll()

disconnectAll(): Promise<void>

Defined in: mcp/src/client/client.ts:320

Returns

Promise<void>

getAllHealth()

getAllHealth(): ServerHealth[]

Defined in: mcp/src/client/client.ts:337

Returns

ServerHealth[]

getHealth()

getHealth(serverName): ServerHealth | undefined

Defined in: mcp/src/client/client.ts:325

Parameters

serverName

string

Returns

ServerHealth | undefined

getInstructions()

getInstructions(serverName): string | undefined

Defined in: mcp/src/client/client.ts:395

Get instructions from a connected server. Instructions describe how to use the server's tools and resources — intended for injection into the LLM's system prompt.

Parameters

serverName

string

Returns

string | undefined

getMcpAppsCapability()

getMcpAppsCapability(serverName): { mimeTypes: string[]; } | undefined

Defined in: mcp/src/client/client.ts:357

Returns the MCP Apps capability declared by a connected server, or undefined if the server didn't advertise the extension. The returned object lists the MIME types the server supports for UI resources (typically ["text/html;profile=mcp-app"]).

Host code should check this before mounting iframes — a server with no apps (or a server whose host declines to serve UI resources) won't declare the capability, and the host should render tool results as plain content.

Parameters

serverName

string

Returns

{ mimeTypes: string[]; } | undefined

getPrompt()

getPrompt(serverName, name, args?, opts?): Promise<PromptResult>

Defined in: mcp/src/client/client.ts:660

Get a prompt by name with optional arguments. Pass opts.timeoutMs: "never" for slow handlers (~24.8 days, effectively indefinite). Defaults to the SDK's 60s when omitted.