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/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L191

Constructors

Constructor

TypeScript
new AxMCPClient(transport: AxMCPTransport, options: Readonly<AxMCPClientOptions>): AxMCPClient;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L227

Parameters

ParameterType
transportAxMCPTransport
optionsReadonly<AxMCPClientOptions>

Returns

AxMCPClient

Methods

acquireResourceSubscription()

TypeScript
acquireResourceSubscription(uri: string, owner: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1159

Acquires one logical owner for a resource subscription.

Parameters

ParameterType
uristring
ownerstring

Returns

Promise<void>


batch()

TypeScript
batch(requests: readonly Readonly<AxMCPBatchRequest<unknown>>[], options?: Readonly<AxMCPRequestOptions>): Promise<readonly AxMCPBatchResponse<unknown>[]>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L362

Parameters

ParameterType
requestsreadonly Readonly<AxMCPBatchRequest<unknown>>[]
options?Readonly<AxMCPRequestOptions>

Returns

Promise<readonly AxMCPBatchResponse<unknown>[]>


callTool()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L857

Parameters

ParameterType
namestring
args?unknown
options?Readonly<AxMCPRequestOptions>

Returns

Promise<AxMCPToolCallResult>


callToolTask()

TypeScript
callToolTask(
   name: string, 
   args?: unknown, 
   task?: AxMCPTaskMetadata, 
options?: Readonly<AxMCPRequestOptions>): Promise<AxMCPCreateTaskResult>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L891

Parameters

ParameterType
namestring
args?unknown
task?AxMCPTaskMetadata
options?Readonly<AxMCPRequestOptions>

Returns

Promise<AxMCPCreateTaskResult>


cancelRequest()

TypeScript
cancelRequest(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1235

Parameters

ParameterType
idstring

Returns

void


cancelTask()

TypeScript
cancelTask(taskId: string): Promise<AxMCPTask>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L954

Parameters

ParameterType
taskIdstring

Returns

Promise<AxMCPTask>


close()

TypeScript
close(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L468

Returns

Promise<void>


complete()

TypeScript
complete(
   ref: AxMCPCompletionReference, 
   argument: AxMCPCompletionArgument, 
context?: object): Promise<AxMCPCompletionResult>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1209

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/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L799

Returns

object

NameType
promptsboolean
resourcesboolean
toolsboolean

getCatalogRevision()

TypeScript
getCatalogRevision(): number;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L445

Returns

number


getEvaluationMode()

TypeScript
getEvaluationMode(): "record" | "live" | "replay" | "sandbox";

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L358

Returns

"record" | "live" | "replay" | "sandbox"


getKnownTasks()

TypeScript
getKnownTasks(): readonly AxMCPTask[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L964

Returns

readonly AxMCPTask[]


getNamespace()

TypeScript
getNamespace(): string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L420

Returns

string


getNegotiatedExtensions()

TypeScript
getNegotiatedExtensions(): Readonly<Record<string, AxMCPExtensionCapability>>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L410

Returns

Readonly<Record<string, AxMCPExtensionCapability>>


getPrompt()

TypeScript
getPrompt(name: string, args?: Record<string, string>): Promise<AxMCPPromptGetResult>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1085

Parameters

ParameterType
namestring
args?Record<string, string>

Returns

Promise<AxMCPPromptGetResult>


getPrompts()

TypeScript
getPrompts(): readonly AxMCPPrompt[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L433

Returns

readonly AxMCPPrompt[]


getProtocolVersion()

TypeScript
getProtocolVersion(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L354

Returns

undefined | string


getResources()

TypeScript
getResources(): readonly AxMCPResource[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L437

Returns

readonly AxMCPResource[]


getResourceSubscriptions()

TypeScript
getResourceSubscriptions(): readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1192

Returns

readonly string[]


getResourceTemplates()

TypeScript
getResourceTemplates(): readonly AxMCPResourceTemplate[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L441

Returns

readonly AxMCPResourceTemplate[]


getServerCapabilities()

TypeScript
getServerCapabilities(): AxMCPServerCapabilities;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L406

Returns

AxMCPServerCapabilities


getServerInfo()

TypeScript
getServerInfo(): 
  | undefined
  | AxMCPImplementationInfo;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L398

Returns

| undefined | AxMCPImplementationInfo


getServerInstructions()

TypeScript
getServerInstructions(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L402

Returns

undefined | string


getTask()

TypeScript
getTask(taskId: string): Promise<AxMCPTask>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L935

Parameters

ParameterType
taskIdstring

Returns

Promise<AxMCPTask>


getTaskResult()

TypeScript
getTaskResult<T>(taskId: string): Promise<T>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L945

Type Parameters

Type ParameterDefault type
TAxMCPToolCallResult

Parameters

ParameterType
taskIdstring

Returns

Promise<T>


getTools()

TypeScript
getTools(): readonly AxMCPTool[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L429

Returns

readonly AxMCPTool[]


hasCompletionsCapability()

TypeScript
hasCompletionsCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L825

Returns

boolean


hasExtension()

TypeScript
hasExtension(name: string): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L416

Parameters

ParameterType
namestring

Returns

boolean


hasLoggingCapability()

TypeScript
hasLoggingCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L831

Returns

boolean


hasPromptsCapability()

TypeScript
hasPromptsCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L813

Returns

boolean


hasResourcesCapability()

TypeScript
hasResourcesCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L819

Returns

boolean


hasTasksCapability()

TypeScript
hasTasksCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L837

Returns

boolean


hasToolsCapability()

TypeScript
hasToolsCapability(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L807

Returns

boolean


init()

TypeScript
init(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L261

Returns

Promise<void>


inspectCatalog()

TypeScript
inspectCatalog(options: Readonly<{
  refresh?: boolean;
}>): Promise<AxMCPCatalogSnapshot>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L449

Parameters

ParameterType
optionsReadonly<{ refresh?: boolean; }>

Returns

Promise<AxMCPCatalogSnapshot>


listPrompts()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1071

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPPromptsListResult>


listResources()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1101

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPResourcesListResult>


listResourceTemplates()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1115

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPResourceTemplatesListResult>


listTasks()

TypeScript
listTasks(cursor?: string): Promise<AxMCPTasksListResult>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L925

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPTasksListResult>


listTools()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L843

Parameters

ParameterType
cursor?string

Returns

Promise<AxMCPToolsListResult>


ping()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L770

Parameters

ParameterTypeDefault value
timeoutnumber3000

Returns

Promise<void>


readResource()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1131

Parameters

ParameterType
uristring

Returns

Promise<AxMCPResourceReadResult>


refresh()

TypeScript
refresh(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L321

Returns

Promise<void>


releaseResourceSubscription()

TypeScript
releaseResourceSubscription(uri: string, owner: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1176

Releases one logical owner without disturbing other subscribers.

Parameters

ParameterType
uristring
ownerstring

Returns

Promise<void>


setLoggingLevel()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1226

Parameters

ParameterType
levelAxMCPLoggingLevel

Returns

Promise<void>


startListening()

TypeScript
startListening(options: Readonly<AxMCPClientListeningOptions>): Promise<AxMCPListeningHandle>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L982

Parameters

ParameterType
optionsReadonly<AxMCPClientListeningOptions>

Returns

Promise<AxMCPListeningHandle>


subscribeEvents()

TypeScript
subscribeEvents(listener: (event: Readonly<AxMCPClientEvent>) => void | Promise<void>): () => void;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L975

Parameters

ParameterType
listener(event: Readonly<AxMCPClientEvent>) => void | Promise<void>

Returns

TypeScript
(): void;
Returns

void


subscribeResource()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1144

Parameters

ParameterType
uristring

Returns

Promise<void>


subscribeTaskStatus()

TypeScript
subscribeTaskStatus(listener: (task: Readonly<AxMCPTask>) => void | Promise<void>): () => void;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L968

Parameters

ParameterType
listener(task: Readonly<AxMCPTask>) => void | Promise<void>

Returns

TypeScript
(): void;
Returns

void


toFunction()

TypeScript
toFunction(): AxFunction[];

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L791

Returns

AxFunction[]


unsubscribeResource()

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

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1151

Parameters

ParameterType
uristring

Returns

Promise<void>


waitForTask()

TypeScript
waitForTask<T>(taskId: string, options: Readonly<{
  defaultPollIntervalMs?: number;
  signal?: AbortSignal;
  timeoutMs?: number;
}>): Promise<T>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/mcp/client.ts#L1031

Type Parameters

Type ParameterDefault type
TAxMCPToolCallResult

Parameters

ParameterType
taskIdstring
optionsReadonly<{ defaultPollIntervalMs?: number; signal?: AbortSignal; timeoutMs?: number; }>

Returns

Promise<T>

Docs