Skip to main content
Defined in: client/interfaces.ts:52

​
Extends

​
Methods

​
[asyncDispose]()

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

​
Returns

Promise<void>

​
callTool()

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

​
Type Parameters

TData
TData = unknown

​
Parameters

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

​
Returns

Promise<CallToolResult<TData>>

​
Inherited from

IToolsClient.callTool

​
close()

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

​
Returns

Promise<void>

​
complete()

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

​
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>

​
connect()

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

​
Returns

Promise<void>

​
getPrompt()

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

​
Parameters

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

​
Returns

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

​
Inherited from

IPromptsClient.getPrompt

​
isConnected()

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

​
Returns

boolean

​
listPrompts()

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

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Inherited from

IPromptsClient.listPrompts

​
listResources()

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

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Inherited from

IResourcesClient.listResources

​
listResourceTemplates()

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

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Inherited from

IResourcesClient.listResourceTemplates

​
listTools()

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

​
Parameters

options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Inherited from

IToolsClient.listTools

​
ping()

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

​
Parameters

options?
RequestOptions

​
Returns

Promise<boolean>

​
readResource()

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

​
Parameters

uri
string
options?
RequestOptions

​
Returns

Promise<{ }[]>

​
Inherited from

IResourcesClient.readResource

​
setLogLevel()

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

​
Parameters

level
LoggingLevel
options?
RequestOptions

​
Returns

Promise<void>

​
subscribeResource()

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

​
Parameters

uri
string
handler
ResourceUpdateHandler
options?
RequestOptions

​
Returns

Promise<void>

​
Inherited from

IResourcesClient.subscribeResource

​
unsubscribeResource()

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

​
Parameters

uri
string
options?
RequestOptions

​
Returns

Promise<void>

​
Inherited from

IResourcesClient.unsubscribeResource