MCPClient

Defined in: packages/mcp-query/src/core/client.ts:101

Constructors

Constructor

new MCPClient(cfg): MCPClient

Defined in: packages/mcp-query/src/core/client.ts:122

Parameters

cfg

MCPClientConfig

Returns

MCPClient

Properties

cache

readonly cache: MCPCache

Defined in: packages/mcp-query/src/core/client.ts:102

---

capsTagFor

capsTagFor: (server, what) => string = capsTag

Defined in: packages/mcp-query/src/core/client.ts:426

A server’s capability catalog. Invalidated by *_list_changed notifications.

Parameters

server

string

what

ListKind

Returns

string

---

interactions?

readonly optional interactions?: InteractionBroker

Defined in: packages/mcp-query/src/core/client.ts:104

The human-in-the-loop broker, if one was configured (read by useInteractions).

Methods

addServer()

addServer(name, conf): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:485

Add and connect a server at runtime.

Parameters

name

string

conf

ConnectionConfig

Returns

Promise<void>

---

callTool()

callTool<A, R>(name, args, opts?): Promise<R>

Defined in: packages/mcp-query/src/core/client.ts:360

Type Parameters

A

A extends Record<string, unknown>

R

R = unknown

Parameters

name

string

args

A

opts?

CallToolOpts<A, R> = {}

Returns

Promise<R>

---

close()

close(): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:205

Returns

Promise<void>

---

complete()

complete(ref, argument, server): Promise<string[]>

Defined in: packages/mcp-query/src/core/client.ts:466

Argument autocompletion for a prompt or resource template (completion/complete).

Parameters

ref

{ name: string; type: "ref/prompt"; } | { type: "ref/resource"; uri: string; }

argument

name

string

value

string

server

string

Returns

Promise<string[]>

---

connect()

connect(): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:187

Connect all eager servers. Lazy ones connect on first use. Failures are isolated.

Returns

Promise<void>

---

connection()

connection(server): ServerConnection | undefined

Defined in: packages/mcp-query/src/core/client.ts:209

Parameters

server

string

Returns

ServerConnection | undefined

---

connections()

connections(): ServerConnection[]

Defined in: packages/mcp-query/src/core/client.ts:212

Returns

ServerConnection[]

---

drain()

drain(): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:282

Graceful shutdown: refuse new ops, await in-flight, then close all connections (SIGTERM).

Returns

Promise<void>

---

getPrompt()

getPrompt(name, args, server?): Promise<{[x: string]: unknown; _meta?: {[x: string]: unknown; io.modelcontextprotocol/related-task?: { taskId: string; }; progressToken?: string | number; }; description?: string; messages: object[]; }>

Defined in: packages/mcp-query/src/core/client.ts:550

Parameters

name

string

args

Record<string, unknown>

server?

string

Returns

Promise<{[x: string]: unknown; _meta?: {[x: string]: unknown; io.modelcontextprotocol/related-task?: { taskId: string; }; progressToken?: string | number; }; description?: string; messages: object[]; }>

---

health()

health(): Promise<Record<string, { ok: boolean; pingMs?: number; state: ServerState; }>>

Defined in: packages/mcp-query/src/core/client.ts:289

Per-server health snapshot for readiness probes (+ does a live ping per server).

Returns

Promise<Record<string, { ok: boolean; pingMs?: number; state: ServerState; }>>

---

listPrompts()

listPrompts(server): object[]

Defined in: packages/mcp-query/src/core/client.ts:423

Parameters

server

string

Returns

object[]

---

listResources()

listResources(server): object[]

Defined in: packages/mcp-query/src/core/client.ts:417

Parameters

server

string

Returns

object[]

---

listResourceTemplates()

listResourceTemplates(server): object[]

Defined in: packages/mcp-query/src/core/client.ts:420

Parameters

server

string

Returns

object[]

---

listTools()

listTools(server): object[]

Defined in: packages/mcp-query/src/core/client.ts:414

Parameters

server

string

Returns

object[]

---

notifyRootsChanged()

notifyRootsChanged(): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:479

Notify every connected server that the client’s roots changed (roots/list_changed).

Returns

Promise<void>

---

ping()

ping(server): Promise<unknown>

Defined in: packages/mcp-query/src/core/client.ts:461

Liveness check — round-trips a ping to detect a silently-dead server.

Parameters

server

string

Returns

Promise<unknown>

---

queryTool()

queryTool<A, R>(name, args, opts?): Promise<R>

Defined in: packages/mcp-query/src/core/client.ts:503

Type Parameters

A

A extends Record<string, unknown>

R

R = unknown

Parameters

name

string

args

A

opts?

QueryToolOpts = {}

Returns

Promise<R>

---

readResource()

readResource(uri, opts?): Promise<unknown>

Defined in: packages/mcp-query/src/core/client.ts:310

Parameters

uri

string

opts?

ReadResourceOpts = {}

Returns

Promise<unknown>

---

removeServer()

removeServer(name): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:493

Disconnect and remove a server at runtime.

Parameters

name

string

Returns

Promise<void>

---

scope()

scope(context): object

Defined in: packages/mcp-query/src/core/client.ts:230

A per-request view bound to a CallContext (partition + meta). Lets one shared client serve many principals: const s = client.scope({ partition: tenantId, meta: { userId } }); await s.readResource(uri). Per-call opts override the bound context.

Parameters

context

CallContext

Returns

object

callTool

callTool: <A, R>(name, args, opts) => Promise<R>

Type Parameters

A

A extends Record<string, unknown>

R

R = unknown

Parameters

name

string

args

A

opts?

CallToolOpts<A, R> = {}

Returns

Promise<R>

queryTool

queryTool: <A, R>(name, args, opts) => Promise<R>

Type Parameters

A

A extends Record<string, unknown>

R

R = unknown

Parameters

name

string

args

A

opts?

QueryToolOpts = {}

Returns

Promise<R>

readResource

readResource: (uri, opts) => Promise<unknown>

Parameters

uri

string

opts?

ReadResourceOpts = {}

Returns

Promise<unknown>

---

serverState()

serverState(server): ServerState

Defined in: packages/mcp-query/src/core/client.ts:215

Parameters

server

string

Returns

ServerState

---

serverStateVersion()

serverStateVersion(): number

Defined in: packages/mcp-query/src/core/client.ts:433

Returns

number

---

setLogLevel()

setLogLevel(server, level): Promise<void>

Defined in: packages/mcp-query/src/core/client.ts:456

Set a server’s logging verbosity (logging/setLevel).

Parameters

server

string

level

string

Returns

Promise<void>

---

subscribeCapabilities()

subscribeCapabilities(cb): () => void

Defined in: packages/mcp-query/src/core/client.ts:220

Subscribe to upstream capability changes (list_changed re-lists). Returns unsubscribe.

Parameters

cb

(server, kind) => void

Returns

() => void

---

subscribeServerState()

subscribeServerState(fn): () => void

Defined in: packages/mcp-query/src/core/client.ts:429

Parameters

fn

() => void

Returns

() => void