Appearance
Abstract Interface: Tool
Defined in: tools/base.ts:21
Base class for all tools.
Accessors
description
Get Signature
ts
get abstract description(): string;Defined in: tools/base.ts:26
Tool description.
Returns
string
name
Get Signature
ts
get abstract name(): string;Defined in: tools/base.ts:23
Tool name.
Returns
string
parameters
Get Signature
ts
get abstract parameters(): Record<string, any>;Defined in: tools/base.ts:29
Tool parameters schema (JSON Schema format).
Returns
Record<string, any>
Methods
execute()
ts
abstract execute(...args): Promise<ToolResult>;Defined in: tools/base.ts:32
Execute the tool with arbitrary arguments.
Parameters
args
...any[]
Returns
Promise<ToolResult>
toOpenaiSchema()
ts
toOpenaiSchema(): Record<string, any>;Defined in: tools/base.ts:44
Convert tool to OpenAI tool schema.
Returns
Record<string, any>
toSchema()
ts
toSchema(): Record<string, any>;Defined in: tools/base.ts:35
Convert tool to Anthropic tool schema.
Returns
Record<string, any>