Skip to main content

Class: Tool

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

A base class for tools that the agent can use.

Extended by​

Constructors​

Constructor​

new Tool(options): Tool

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

Parameters​

options​

ToolOptions

The options for the tool.

Returns​

Tool

Properties​

description?​

optional description: string

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

name​

name: string

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

onTriggered()?​

optional onTriggered: (args) => unknown

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

Parameters​

args​

unknown

Returns​

unknown

parameters?​

optional parameters: ToolSchema

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

Methods​

execute()​

execute(args): unknown

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

Executes the tool's action.

Parameters​

args​

unknown

The arguments for the tool.

Returns​

unknown

The result of the tool's action.

toJSON()​

toJSON(): FunctionDeclaration

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

Returns a JSON representation of the tool.

Returns​

FunctionDeclaration

A valid FunctionDeclaration object.