AxMCPClient
Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L98
Constructors
Constructor
new AxMCPClient(transport: AxMCPTransport, options: Readonly<AxMCPClientOptions>): AxMCPClient;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L110
Parameters
| Parameter | Type |
|---|---|
transport | AxMCPTransport |
options | Readonly<AxMCPClientOptions> |
Returns
AxMCPClient
Methods
callTool()
callTool(name: string, args?: unknown): Promise<AxMCPToolCallResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L537
Parameters
| Parameter | Type |
|---|---|
name | string |
args? | unknown |
Returns
Promise<AxMCPToolCallResult>
cancelRequest()
cancelRequest(id: string): void;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L671
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
complete()
complete(
ref: AxMCPCompletionReference,
argument: AxMCPCompletionArgument,
context?: object): Promise<AxMCPCompletionResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L645
Parameters
| Parameter | Type |
|---|---|
ref | AxMCPCompletionReference |
argument | AxMCPCompletionArgument |
context? | { arguments?: Record<string, string>; } |
context.arguments? | Record<string, string> |
Returns
Promise<AxMCPCompletionResult>
getCapabilities()
getCapabilities(): object;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L485
Returns
object
| Name | Type |
|---|---|
prompts | boolean |
resources | boolean |
tools | boolean |
getPrompt()
getPrompt(name: string, args?: Record<string, string>): Promise<AxMCPPromptGetResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L564
Parameters
| Parameter | Type |
|---|---|
name | string |
args? | Record<string, string> |
Returns
Promise<AxMCPPromptGetResult>
getProtocolVersion()
getProtocolVersion(): undefined | string;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L184
Returns
undefined | string
getServerCapabilities()
getServerCapabilities(): AxMCPServerCapabilities;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L196
Returns
getServerInfo()
getServerInfo():
| undefined
| AxMCPImplementationInfo;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L188
Returns
| undefined
| AxMCPImplementationInfo
getServerInstructions()
getServerInstructions(): undefined | string;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L192
Returns
undefined | string
hasCompletionsCapability()
hasCompletionsCapability(): boolean;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L511
Returns
boolean
hasLoggingCapability()
hasLoggingCapability(): boolean;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L517
Returns
boolean
hasPromptsCapability()
hasPromptsCapability(): boolean;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L499
Returns
boolean
hasResourcesCapability()
hasResourcesCapability(): boolean;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L505
Returns
boolean
hasToolsCapability()
hasToolsCapability(): boolean;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L493
Returns
boolean
init()
init(): Promise<void>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L128
Returns
Promise<void>
listPrompts()
listPrompts(cursor?: string): Promise<AxMCPPromptsListResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L550
Parameters
| Parameter | Type |
|---|---|
cursor? | string |
Returns
Promise<AxMCPPromptsListResult>
listResources()
listResources(cursor?: string): Promise<AxMCPResourcesListResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L580
Parameters
| Parameter | Type |
|---|---|
cursor? | string |
Returns
Promise<AxMCPResourcesListResult>
listResourceTemplates()
listResourceTemplates(cursor?: string): Promise<AxMCPResourceTemplatesListResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L594
Parameters
| Parameter | Type |
|---|---|
cursor? | string |
Returns
Promise<AxMCPResourceTemplatesListResult>
listTools()
listTools(cursor?: string): Promise<AxMCPToolsListResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L523
Parameters
| Parameter | Type |
|---|---|
cursor? | string |
Returns
Promise<AxMCPToolsListResult>
ping()
ping(timeout: number): Promise<void>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L456
Parameters
| Parameter | Type | Default value |
|---|---|---|
timeout | number | 3000 |
Returns
Promise<void>
readResource()
readResource(uri: string): Promise<AxMCPResourceReadResult>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L610
Parameters
| Parameter | Type |
|---|---|
uri | string |
Returns
Promise<AxMCPResourceReadResult>
refresh()
refresh(): Promise<void>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L166
Returns
Promise<void>
setLoggingLevel()
setLoggingLevel(level: AxMCPLoggingLevel): Promise<void>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L662
Parameters
| Parameter | Type |
|---|---|
level | AxMCPLoggingLevel |
Returns
Promise<void>
subscribeResource()
subscribeResource(uri: string): Promise<void>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L623
Parameters
| Parameter | Type |
|---|---|
uri | string |
Returns
Promise<void>
toFunction()
toFunction(): AxFunction[];Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L477
Returns
unsubscribeResource()
unsubscribeResource(uri: string): Promise<void>;Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L634
Parameters
| Parameter | Type |
|---|---|
uri | string |
Returns
Promise<void>