Skip to main content

Type Alias: ToolOptions

ToolOptions = object

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

Properties​

description​

description: string

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

A description of what the tool does.

name​

name: string

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

The name of the tool.

onTriggered()?​

optional onTriggered: (args) => unknown

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

A callback to execute when the tool is triggered

Parameters​

args​

unknown

Returns​

unknown

parameters?​

optional parameters: ToolSchema

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

The parameters of the tool