Class ClientToolRegistry

Registry for client-side tools that agents can invoke.

Tools are registered by the client application and can be executed when the agent sends a ClientToolRequest over the transport.

Index

Constructors

Methods

Execute GetAllTools GetTool Register Unregister

Constructors

constructor

new ClientToolRegistry(): ClientToolRegistry
Returns ClientToolRegistry

Methods

Execute

Execute(
    name: string,
    params: Record<string, unknown>,
    timeoutMs?: number,
): Promise<ClientToolResult>
Execute a registered tool with timeout protection.
Parameters
- name: string
  The name of the tool to execute
- params: Record<string, unknown>
  Parameters to pass to the tool handler
- OptionaltimeoutMs: number
  Maximum execution time in ms (default: 30s)
Returns Promise<ClientToolResult>
The tool result, or a timeout/not-found error result
- Defined in AI/AgentsClient/dist/generic/ClientToolRegistry.d.ts:67

GetAllTools

GetAllTools(): ClientToolDefinition[]
Get all registered tool definitions.

Returns ClientToolDefinition[]
- Defined in AI/AgentsClient/dist/generic/ClientToolRegistry.d.ts:58

GetTool

GetTool(name: string): ClientToolDefinition | undefined
Get a tool definition by name.
Parameters
- name: string
  The tool name to look up
Returns ClientToolDefinition | undefined
The tool definition, or undefined if not found
- Defined in AI/AgentsClient/dist/generic/ClientToolRegistry.d.ts:54

Register

Register(tool: ClientToolDefinition): void
Register a client-side tool.
Parameters
- tool: ClientToolDefinition
  The tool definition to register
Returns void
Throws
Error if a tool with the same name is already registered
- Defined in AI/AgentsClient/dist/generic/ClientToolRegistry.d.ts:41

Unregister

Unregister(toolName: string): void
Unregister a client-side tool.
Parameters
- toolName: string
  The name of the tool to unregister
Returns void
- Defined in AI/AgentsClient/dist/generic/ClientToolRegistry.d.ts:47