tools / Exports / Tool

Interface: Tool<TInput, TOutput>

Tool interface

Type parameters

Name	Type
TInput	any
TOutput	any

Table of contents

Properties

• name
• description
• parameters
• execute

Properties

name

• name: string

Tool name

Defined in

packages/tools/src/index.ts:65

---

description

• Optional description: string

Tool description

Defined in

packages/tools/src/index.ts:70

---

parameters

• Optional parameters: ToolParameter[]

Tool parameter definitions

Defined in

packages/tools/src/index.ts:75

---

execute

• execute: (input: TInput) => Promise<ToolResult<TOutput>>

Tool execution function

Type declaration

▸ (input): Promise<ToolResult<TOutput>>

Parameters

Name	Type	Description
input	TInput	Tool input parameters

Returns

Promise<ToolResult<TOutput>>

Defined in

packages/tools/src/index.ts:83