Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/mcp / / MCPClient
Interface: MCPClient
Defined in: packages/mcp/src/client/types.ts:348
Public surface of an active MCP client.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
collisionStrategy | readonly | CollisionStrategy | Per-client default collision strategy. | packages/mcp/src/client/types.ts:356 |
id | readonly | string | Stable identifier - derived from the transport. | packages/mcp/src/client/types.ts:350 |
priority? | readonly | number | Per-client priority value used by the 'priority' strategy. | packages/mcp/src/client/types.ts:358 |
resumable | readonly | boolean | Deprecated Alias of sessionIdPresent - same value, misleading name. | packages/mcp/src/client/types.ts:369 |
serverIdentity | readonly | ServerIdentity | Server identity descriptor consumed by the tool-registry resolver. | packages/mcp/src/client/types.ts:354 |
serverInfo | readonly | { name: string; version: string; } | Server-advertised information from the initialize handshake. | packages/mcp/src/client/types.ts:352 |
serverInfo.name | readonly | string | - | packages/mcp/src/client/types.ts:352 |
serverInfo.version | readonly | string | - | packages/mcp/src/client/types.ts:352 |
sessionIdPresent | readonly | boolean | Whether the Streamable HTTP server assigned an Mcp-Session-Id at initialize time (MC-9). 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()
callTool(
name,
args,
opts?): Promise<MCPCallToolResult>;Defined in: packages/mcp/src/client/types.ts:374
Parameters
| Parameter | Type |
|---|---|
name | string |
args | unknown |
opts? | { signal?: AbortSignal; timeoutMs?: number; } |
opts.signal? | AbortSignal |
opts.timeoutMs? | number |
Returns
Promise<MCPCallToolResult>
close()
close(): Promise<void>;Defined in: packages/mcp/src/client/types.ts:397
Returns
Promise<void>
getPrompt()
getPrompt(
name,
args?,
opts?): Promise<{
messages: readonly MCPPromptMessage[];
}>;Defined in: packages/mcp/src/client/types.ts:391
Parameters
| Parameter | Type |
|---|---|
name | string |
args? | unknown |
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<{ messages: readonly MCPPromptMessage[]; }>
listPrompts()
listPrompts(opts?): Promise<readonly MCPPromptDefinition[]>;Defined in: packages/mcp/src/client/types.ts:373
Parameters
| Parameter | Type |
|---|---|
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<readonly MCPPromptDefinition[]>
listResources()
listResources(opts?): Promise<readonly MCPResourceDefinition[]>;Defined in: packages/mcp/src/client/types.ts:372
Parameters
| Parameter | Type |
|---|---|
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<readonly MCPResourceDefinition[]>
listTools()
listTools(opts?): Promise<readonly MCPToolDefinition[]>;Defined in: packages/mcp/src/client/types.ts:371
Parameters
| Parameter | Type |
|---|---|
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<readonly MCPToolDefinition[]>
readResource()
readResource(uri, opts?): Promise<MCPResourceContent>;Defined in: packages/mcp/src/client/types.ts:385
First content item of the resource. mcp-skills-11: 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
| Parameter | Type |
|---|---|
uri | string |
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<MCPResourceContent>
readResourceContents()
readResourceContents(uri, opts?): Promise<readonly MCPResourceContent[]>;Defined in: packages/mcp/src/client/types.ts:387
Every content item of the resource (mcp-skills-11).
Parameters
| Parameter | Type |
|---|---|
uri | string |
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<readonly MCPResourceContent[]>
toTools()
toTools(opts?): Promise<readonly Tool<unknown, unknown, unknown>[]>;Defined in: packages/mcp/src/client/types.ts:396
Parameters
| Parameter | Type |
|---|---|
opts? | MCPToToolsOptions |
Returns
Promise<readonly Tool<unknown, unknown, unknown>[]>