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

Extends

Methods

[asyncDispose]()

Defined in: client/interfaces.ts:65

Returns

Promise<void>

callTool()

Defined in: client/interfaces.ts:29

Type Parameters

TData
TData = unknown

Parameters

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

Returns

Promise<CallToolResult<TData>>

Inherited from

IToolsClient.callTool

close()

Defined in: client/interfaces.ts:55

Returns

Promise<void>

complete()

Defined in: client/interfaces.ts:58

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()

Defined in: client/interfaces.ts:54

Returns

Promise<void>

getPrompt()

Defined in: client/interfaces.ts:46

Parameters

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

Returns

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

Inherited from

IPromptsClient.getPrompt

isConnected()

Defined in: client/interfaces.ts:56

Returns

boolean

listPrompts()

Defined in: client/interfaces.ts:45

Parameters

options?
RequestOptions

Returns

Promise<{ }[]>

Inherited from

IPromptsClient.listPrompts

listResources()

Defined in: client/interfaces.ts:37

Parameters

options?
RequestOptions

Returns

Promise<{ }[]>

Inherited from

IResourcesClient.listResources

listResourceTemplates()

Defined in: client/interfaces.ts:38

Parameters

options?
RequestOptions

Returns

Promise<{ }[]>

Inherited from

IResourcesClient.listResourceTemplates

listTools()

Defined in: client/interfaces.ts:28

Parameters

options?
RequestOptions

Returns

Promise<{ }[]>

Inherited from

IToolsClient.listTools

ping()

Defined in: client/interfaces.ts:57

Parameters

options?
RequestOptions

Returns

Promise<boolean>

readResource()

Defined in: client/interfaces.ts:39

Parameters

uri
string
options?
RequestOptions

Returns

Promise<( | { } | { })[]>

Inherited from

IResourcesClient.readResource

setLogLevel()

Defined in: client/interfaces.ts:64

Parameters

level
LoggingLevel
options?
RequestOptions

Returns

Promise<void>

subscribeResource()

Defined in: client/interfaces.ts:40

Parameters

uri
string
handler
ResourceUpdateHandler
options?
RequestOptions

Returns

Promise<void>

Inherited from

IResourcesClient.subscribeResource

unsubscribeResource()

Defined in: client/interfaces.ts:41

Parameters

uri
string
options?
RequestOptions

Returns

Promise<void>

Inherited from

IResourcesClient.unsubscribeResource