tools / Exports / ToolInterface
Interface: ToolInterface
Tool interface
Description
Base interface that all tools must implement.
Implemented by
Table of contents
Properties
Methods
Properties
name
• name: string
Tool name
Defined in
packages/tools/src/tool/interfaces.ts:33
description
• Optional description: string
Tool description
Defined in
packages/tools/src/tool/interfaces.ts:38
schema
• schema: any
Tool schema
Defined in
packages/tools/src/tool/interfaces.ts:43
execute
• execute: (args: any) => Promise<any>
Tool execution function
Type declaration
▸ (args): Promise<any>
Parameters
| Name | Type |
|---|---|
args | any |
Returns
Promise<any>
Defined in
packages/tools/src/tool/interfaces.ts:48
Methods
toFunctionDefinition
▸ toFunctionDefinition(): FunctionDefinition
Convert to function definition