Skip to content

Graphorin API reference v0.4.0


Graphorin API reference / @graphorin/mcp / / MCPClient

Interface: MCPClient

Defined in: packages/mcp/src/client/types.ts:306

Public surface of an active MCP client.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
collisionStrategyreadonlyCollisionStrategyPer-client default collision strategy.packages/mcp/src/client/types.ts:314
idreadonlystringStable identifier — derived from the transport.packages/mcp/src/client/types.ts:308
priority?readonlynumberPer-client priority value used by the 'priority' strategy.packages/mcp/src/client/types.ts:316
resumablereadonlybooleanWhether the connected server advertises Streamable HTTP session support (resolved at initialize time).packages/mcp/src/client/types.ts:321
serverIdentityreadonlyServerIdentityServer identity descriptor consumed by the tool-registry resolver.packages/mcp/src/client/types.ts:312
serverInforeadonly{ name: string; version: string; }Server-advertised information from the initialize handshake.packages/mcp/src/client/types.ts:310
serverInfo.namereadonlystring-packages/mcp/src/client/types.ts:310
serverInfo.versionreadonlystring-packages/mcp/src/client/types.ts:310

Methods

callTool()

ts
callTool(
   name, 
   args, 
opts?): Promise<MCPCallToolResult>;

Defined in: packages/mcp/src/client/types.ts:326

Parameters

ParameterType
namestring
argsunknown
opts?{ signal?: AbortSignal; timeoutMs?: number; }
opts.signal?AbortSignal
opts.timeoutMs?number

Returns

Promise&lt;MCPCallToolResult&gt;


close()

ts
close(): Promise<void>;

Defined in: packages/mcp/src/client/types.ts:338

Returns

Promise&lt;void&gt;


getPrompt()

ts
getPrompt(
   name, 
   args?, 
   opts?): Promise<{
  messages: readonly MCPPromptMessage[];
}>;

Defined in: packages/mcp/src/client/types.ts:332

Parameters

ParameterType
namestring
args?unknown
opts?{ signal?: AbortSignal; }
opts.signal?AbortSignal

Returns

Promise<{ messages: readonly MCPPromptMessage[]; }>


listPrompts()

ts
listPrompts(opts?): Promise<readonly MCPPromptDefinition[]>;

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

Parameters

ParameterType
opts?{ signal?: AbortSignal; }
opts.signal?AbortSignal

Returns

Promise&lt;readonly MCPPromptDefinition[]&gt;


listResources()

ts
listResources(opts?): Promise<readonly MCPResourceDefinition[]>;

Defined in: packages/mcp/src/client/types.ts:324

Parameters

ParameterType
opts?{ signal?: AbortSignal; }
opts.signal?AbortSignal

Returns

Promise&lt;readonly MCPResourceDefinition[]&gt;


listTools()

ts
listTools(opts?): Promise<readonly MCPToolDefinition[]>;

Defined in: packages/mcp/src/client/types.ts:323

Parameters

ParameterType
opts?{ signal?: AbortSignal; }
opts.signal?AbortSignal

Returns

Promise&lt;readonly MCPToolDefinition[]&gt;


readResource()

ts
readResource(uri, opts?): Promise<MCPResourceContent>;

Defined in: packages/mcp/src/client/types.ts:331

Parameters

ParameterType
uristring
opts?{ signal?: AbortSignal; }
opts.signal?AbortSignal

Returns

Promise&lt;MCPResourceContent&gt;


toTools()

ts
toTools(opts?): Promise<readonly Tool<unknown, unknown, unknown>[]>;

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

Parameters

ParameterType
opts?MCPToToolsOptions

Returns

Promise<readonly Tool&lt;unknown, unknown, unknown&gt;[]>