Defined in: tool.ts:41
A capability that an agent can call by name.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
description |
string |
Description that tells the model when to use the tool. | tool.ts:45 |
name |
string |
Unique tool name. | tool.ts:43 |
parameters? |
ToolParameters |
JSON Schema of the arguments. | tool.ts:47 |
Methods
invoke()
invoke(args): Promise<unknown>;
Defined in: tool.ts:52
Runs the tool.
Parameters
| Parameter | Type | Description |
|---|---|---|
args |
Record<string, unknown> |
Arguments that match parameters. |
Returns
Promise<unknown>