tools / Exports / ToolFunction

Interface: ToolFunction<TParams, TResult>

Function interface

Type parameters

Name	Type
TParams	unknown
TResult	unknown

Table of contents

Properties

• name
• description
• schema
• execute

Properties

name

• name: string

Defined in

packages/tools/src/function.ts:34

---

description

• Optional description: string

Defined in

packages/tools/src/function.ts:35

---

schema

• schema: FunctionDefinition

Defined in

packages/tools/src/function.ts:36

---

execute

• execute: (params: TParams) => Promise<TResult>

Type declaration

▸ (params): Promise<TResult>

Parameters

Name	Type
params	TParams

Returns

Promise<TResult>

Defined in

packages/tools/src/function.ts:37