Skip to content

Graphorin API reference v0.15.1


Graphorin API reference / @graphorin/mcp / / MCPClient

Interface: MCPClient ​

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

Stable

Public surface of an active MCP client.

Properties ​

PropertyModifierTypeDescriptionDefined in
collisionStrategyreadonlyCollisionStrategyPer-client default collision strategy.packages/mcp/src/client/types.ts:356
idreadonlystringStable identifier - derived from the transport.packages/mcp/src/client/types.ts:350
priority?readonlynumberPer-client priority value used by the 'priority' strategy.packages/mcp/src/client/types.ts:358
resumablereadonlybooleanDeprecated Alias of sessionIdPresent - same value, misleading name.packages/mcp/src/client/types.ts:369
serverIdentityreadonlyServerIdentityServer identity descriptor consumed by the tool-registry resolver.packages/mcp/src/client/types.ts:354
serverInforeadonly{ name: string; version: string; }Server-advertised information from the initialize handshake.packages/mcp/src/client/types.ts:352
serverInfo.namereadonlystring-packages/mcp/src/client/types.ts:352
serverInfo.versionreadonlystring-packages/mcp/src/client/types.ts:352
sessionIdPresentreadonlybooleanWhether the Streamable HTTP server assigned an Mcp-Session-Id at initialize time. A session id means stateful routing - it is NOT a replay guarantee: per the Streamable HTTP spec, event replay is the SERVER's responsibility, and the SDK transport already auto-reconnects with Last-Event-ID when the server supports it.packages/mcp/src/client/types.ts:367

Methods ​

callTool() ​

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

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

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:397

Returns ​

Promise&lt;void&gt;


getPrompt() ​

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

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

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:373

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:372

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:371

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:385

First content item of the resource. A multi-content response (one URI can yield several items) is truncated to the FIRST item - a WARN + counter fire when that happens; use readResourceContents for the full array.

Parameters ​

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

Returns ​

Promise&lt;MCPResourceContent&gt;


readResourceContents() ​

ts
readResourceContents(uri, opts?): Promise<readonly MCPResourceContent[]>;

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

Every content item of the resource.

Parameters ​

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

Returns ​

Promise&lt;readonly MCPResourceContent[]&gt;


toTools() ​

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

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

Parameters ​

ParameterType
opts?MCPToToolsOptions

Returns ​

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