AxMCPClient Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxMCPClient.md class AxMCPClient

AxMCPClient

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L98

Constructors

Constructor

TypeScript
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

ParameterType
transportAxMCPTransport
optionsReadonly<AxMCPClientOptions>

Returns

AxMCPClient

Methods

callTool()

TypeScript
callTool(name: string, args?: unknown): Promise<AxMCPToolCallResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L537

Parameters

ParameterType
namestring
args?unknown

Returns

Promise<AxMCPToolCallResult>


cancelRequest()

TypeScript
cancelRequest(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L671

Parameters

ParameterType
idstring

Returns

void


complete()

TypeScript
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

ParameterType
refAxMCPCompletionReference
argumentAxMCPCompletionArgument
context?{ arguments?: Record<string, string>; }
context.arguments?Record<string, string>

Returns

Promise<AxMCPCompletionResult>


getCapabilities()

TypeScript
getCapabilities(): object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L485

Returns

object

NameType
promptsboolean
resourcesboolean
toolsboolean

getPrompt()

TypeScript
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

ParameterType
namestring
args?Record<string, string>

Returns

Promise<AxMCPPromptGetResult>


getProtocolVersion()

TypeScript
getProtocolVersion(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L184

Returns

undefined | string


getServerCapabilities()

TypeScript
getServerCapabilities(): AxMCPServerCapabilities;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L196

Returns

AxMCPServerCapabilities


getServerInfo()

TypeScript
getServerInfo(): 
  | undefined
  | AxMCPImplementationInfo;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L188

Returns

| undefined | AxMCPImplementationInfo


getServerInstructions()

TypeScript
getServerInstructions(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L192

Returns

undefined | string


hasCompletionsCapability()

TypeScript
hasCompletionsCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L511

Returns

boolean


hasLoggingCapability()

TypeScript
hasLoggingCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L517

Returns

boolean


hasPromptsCapability()

TypeScript
hasPromptsCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L499

Returns

boolean


hasResourcesCapability()

TypeScript
hasResourcesCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L505

Returns

boolean


hasToolsCapability()

TypeScript
hasToolsCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L493

Returns

boolean


init()

TypeScript
init(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L128

Returns

Promise<void>


listPrompts()

TypeScript
listPrompts(cursor?: string): Promise<AxMCPPromptsListResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L550

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPPromptsListResult>


listResources()

TypeScript
listResources(cursor?: string): Promise<AxMCPResourcesListResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L580

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPResourcesListResult>


listResourceTemplates()

TypeScript
listResourceTemplates(cursor?: string): Promise<AxMCPResourceTemplatesListResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L594

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPResourceTemplatesListResult>


listTools()

TypeScript
listTools(cursor?: string): Promise<AxMCPToolsListResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L523

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPToolsListResult>


ping()

TypeScript
ping(timeout: number): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L456

Parameters

ParameterTypeDefault value
timeoutnumber3000

Returns

Promise<void>


readResource()

TypeScript
readResource(uri: string): Promise<AxMCPResourceReadResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L610

Parameters

ParameterType
uristring

Returns

Promise<AxMCPResourceReadResult>


refresh()

TypeScript
refresh(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L166

Returns

Promise<void>


setLoggingLevel()

TypeScript
setLoggingLevel(level: AxMCPLoggingLevel): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L662

Parameters

ParameterType
levelAxMCPLoggingLevel

Returns

Promise<void>


subscribeResource()

TypeScript
subscribeResource(uri: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L623

Parameters

ParameterType
uristring

Returns

Promise<void>


toFunction()

TypeScript
toFunction(): AxFunction[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L477

Returns

AxFunction[]


unsubscribeResource()

TypeScript
unsubscribeResource(uri: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/mcp/client.ts#L634

Parameters

ParameterType
uristring

Returns

Promise<void>

Docs