@sagentic-ai/sagentic-af / Tool

Tool

Properties

describe

describe: () => ChatCompletionTool;

Convert a tool to OpenAI compatible tool schema.

Returns

ChatCompletionTool

OpenAI compatible JSON schema as JS object

Source

src/tool.ts:32

---

description

description: string;

Description of the tool

Source

src/tool.ts:20

---

invoke

invoke: (agent, args) => Promise<any>;

Invoke the tool.

Parameters

• agent: Agent

• args: any

Arguments for the tool

Returns

Promise<any>

Return value of the tool

Throws

Error if the arguments are invalid or not supported

Source

src/tool.ts:27

---

name

name: string;

Name of the tool

Source

src/tool.ts:17