Skip to main content

Class: Tool

Defined in: src/agent/Tool.ts:48

A base class for tools that the agent can use.

Extended by​

Constructors​

Constructor​

new Tool(options): Tool

Defined in: src/agent/Tool.ts:58

Parameters​

options​

ToolOptions

The options for the tool.

Returns​

Tool

Properties​

behavior?​

optional behavior: "BLOCKING" | "NON_BLOCKING"

Defined in: src/agent/Tool.ts:53

description?​

optional description: string

Defined in: src/agent/Tool.ts:50

name​

name: string

Defined in: src/agent/Tool.ts:49

onTriggered()?​

optional onTriggered: (args) => unknown

Defined in: src/agent/Tool.ts:52

Parameters​

args​

unknown

Returns​

unknown

parameters?​

optional parameters: ToolSchema

Defined in: src/agent/Tool.ts:51

Methods​

execute()​

execute(args): Promise<ToolResult<unknown>>

Defined in: src/agent/Tool.ts:71

Executes the tool's action with standardized error handling.

Parameters​

args​

unknown

The arguments for the tool.

Returns​

Promise<ToolResult<unknown>>

A promise that resolves with a ToolResult containing success/error information.

toJSON()​

toJSON(): FunctionDeclaration

Defined in: src/agent/Tool.ts:97

Returns a JSON representation of the tool.

Returns​

FunctionDeclaration

A valid FunctionDeclaration object.