Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/mcp / / MCPClient
Interface: MCPClient
Defined in: packages/mcp/src/client/types.ts:178
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:186 |
id | readonly | string | Stable identifier — derived from the transport. | packages/mcp/src/client/types.ts:180 |
priority? | readonly | number | Per-client priority value used by the 'priority' strategy. | packages/mcp/src/client/types.ts:188 |
resumable | readonly | boolean | Whether the connected server advertises Streamable HTTP session support (resolved at initialize time). | packages/mcp/src/client/types.ts:193 |
serverIdentity | readonly | ServerIdentity | Server identity descriptor consumed by the tool-registry resolver. | packages/mcp/src/client/types.ts:184 |
serverInfo | readonly | { name: string; version: string; } | Server-advertised information from the initialize handshake. | packages/mcp/src/client/types.ts:182 |
serverInfo.name | readonly | string | - | packages/mcp/src/client/types.ts:182 |
serverInfo.version | readonly | string | - | packages/mcp/src/client/types.ts:182 |
Methods
callTool()
callTool(
name,
args,
opts?): Promise<MCPCallToolResult>;Defined in: packages/mcp/src/client/types.ts:198
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:210
Returns
Promise<void>
getPrompt()
getPrompt(
name,
args?,
opts?): Promise<{
messages: readonly MCPPromptMessage[];
}>;Defined in: packages/mcp/src/client/types.ts:204
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:197
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:196
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:195
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:203
Parameters
| Parameter | Type |
|---|---|
uri | string |
opts? | { signal?: AbortSignal; } |
opts.signal? | AbortSignal |
Returns
Promise<MCPResourceContent>
toTools()
toTools(opts?): Promise<readonly Tool<unknown, unknown, unknown>[]>;Defined in: packages/mcp/src/client/types.ts:209
Parameters
| Parameter | Type |
|---|---|
opts? | MCPToToolsOptions |
Returns
Promise<readonly Tool<unknown, unknown, unknown>[]>