Skip to main content
Defined in: client/client.ts:107

​
Implements

​
Constructors

​
Constructor

new Client(input, options?): Client;
Defined in: client/client.ts:121

​
Parameters

input
ClientTransportInput
options?
ClientOptions

​
Returns

Client

​
Methods

​
[asyncDispose]()

asyncDispose: Promise<void>;
Defined in: client/client.ts:243

​
Returns

Promise<void>

​
Implementation of

IClient.[asyncDispose]

​
callTool()

callTool<TData>(
   name, 
   args?, 
   options?): Promise<CallToolResult<TData>>;
Defined in: client/client.ts:293

​
Type Parameters

TData
TData = unknown

​
Parameters

name
string
args?
Record<string, unknown>
options?
CallToolOptions

​
Returns

Promise<CallToolResult<TData>>

​
Implementation of

IClient.callTool

​
callToolRaw()

callToolRaw<TData>(
   name, 
   args?, 
   options?): Promise<CallToolResult<TData>>;
Defined in: client/client.ts:311 Returns the full result including isError without throwing.

​
Type Parameters

TData
TData = unknown

​
Parameters

name
string
args?
Record<string, unknown>
options?
CallToolOptions

​
Returns

Promise<CallToolResult<TData>>

​
close()

close(): Promise<void>;
Defined in: client/client.ts:234

​
Returns

Promise<void>

​
Implementation of

IClient.close

​
complete()

complete(
   ref, 
   argument, 
   context?, 
   options?): Promise<CompletionResult>;
Defined in: client/client.ts:417

​
Parameters

ref
| { name: string; type: "ref/prompt"; } | { type: "ref/resource"; uri: string; }
argument
name
string
value
string
context?
arguments?
Record<string, string>
options?
RequestOptions

​
Returns

Promise<CompletionResult>

​
Implementation of

IClient.complete

​
connect()

connect(): Promise<void>;
Defined in: client/client.ts:142

​
Returns

Promise<void>

​
Implementation of

IClient.connect

​
getPrompt()

getPrompt(
   name, 
   args?, 
   options?): Promise<{
[key: string]: unknown;
}>;
Defined in: client/client.ts:401

​
Parameters

name
string
args?
Record<string, string>
options?
RequestOptions

​
Returns

Promise<{ [key: string]: unknown; }>

​
Implementation of

IClient.getPrompt

​
isConnected()

isConnected(): boolean;
Defined in: client/client.ts:247

​
Returns

boolean

​
Implementation of

IClient.isConnected

​
listPrompts()

listPrompts(options?): Promise<{
}[]>;
Defined in: client/client.ts:393

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Implementation of

IClient.listPrompts

​
listResources()

listResources(options?): Promise<{
}[]>;
Defined in: client/client.ts:337

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Implementation of

IClient.listResources

​
listResourceTemplates()

listResourceTemplates(options?): Promise<{
}[]>;
Defined in: client/client.ts:345

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Implementation of

IClient.listResourceTemplates

​
listTools()

listTools(options?): Promise<{
}[]>;
Defined in: client/client.ts:285

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Implementation of

IClient.listTools

​
notifyRootsChanged()

notifyRootsChanged(): Promise<void>;
Defined in: client/client.ts:543 Notify the connected server that the client’s roots list has changed. The server should re-issue a roots/list request to get the updated list.

​
Returns

Promise<void>

​
ping()

ping(options?): Promise<boolean>;
Defined in: client/client.ts:276

​
Parameters

options?
RequestOptions

​
Returns

Promise<boolean>

​
Implementation of

IClient.ping

​
readResource()

readResource(uri, options?): Promise<{
}[]>;
Defined in: client/client.ts:353

​
Parameters

uri
string
options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Implementation of

IClient.readResource

​
readResourceRaw()

readResourceRaw(uri, options?): Promise<{
[x: string]: unknown;
}>;
Defined in: client/client.ts:362 Returns the raw SDK ReadResourceResult without unwrapping.

​
Parameters

uri
string
options?
RequestOptions

​
Returns

Promise<{ [x: string]: unknown; }>

​
setLogLevel()

setLogLevel(level, options?): Promise<void>;
Defined in: client/client.ts:434

​
Parameters

level
LoggingLevel
options?
RequestOptions

​
Returns

Promise<void>

​
Implementation of

IClient.setLogLevel

​
subscribeResource()

subscribeResource(
   uri, 
   handler, 
   options?): Promise<void>;
Defined in: client/client.ts:369

​
Parameters

uri
string
handler
ResourceUpdateHandler
options?
RequestOptions

​
Returns

Promise<void>

​
Implementation of

IClient.subscribeResource

​
unsubscribeResource()

unsubscribeResource(uri, options?): Promise<void>;
Defined in: client/client.ts:381

​
Parameters

uri
string
options?
RequestOptions

​
Returns

Promise<void>

​
Implementation of

IClient.unsubscribeResource

​
connect()

​
Call Signature

static connect(input, options?): Promise<MultiServerClient>;
Defined in: client/client.ts:252 Creates a connected MultiServerClient when given a multi-entry McpConfig.
Parameters
input
McpConfig
options?
MultiServerOptions
Returns
Promise<MultiServerClient>

​
Call Signature

static connect(input, options?): Promise<Client>;
Defined in: client/client.ts:254 Creates a connected Client for a single-server transport. Use with await using for automatic cleanup.
Parameters
input
ClientTransportInput
options?
ClientOptions
Returns
Promise<Client>