Skip to main content

Type Alias: ToolOptions

ToolOptions = object

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

Properties​

behavior?​

optional behavior: "BLOCKING" | "NON_BLOCKING" | GoogleGenAITypes.Behavior

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

description​

description: string

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

A description of what the tool does.

name​

name: string

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

The name of the tool.

onTriggered()?​

optional onTriggered: (args) => unknown | Promise<unknown>

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

A callback to execute when the tool is triggered

Parameters​

args​

unknown

Returns​

unknown | Promise<unknown>

parameters?​

optional parameters: ToolSchema

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

The parameters of the tool