tools / Exports / CreateToolOptions

Interface: CreateToolOptions<TInput, TOutput>

Tool creation options

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:93

---

description

• Optional description: string

Tool description

Defined in

packages/tools/src/index.ts:98

---

parameters

• Optional parameters: ToolParameter[]

Tool parameter definitions

Defined in

packages/tools/src/index.ts:103

---

execute

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

Tool execution function

Type declaration

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

Parameters

Name	Type
input	TInput

Returns

Promise<TOutput | ToolResult<TOutput>>

Defined in

packages/tools/src/index.ts:108