Skip to content

tools / Exports / ToolResult

Interface: ToolResult<T>

Tool execution result type

Type parameters

NameType
Tany

Table of contents

Properties

Properties

success

success: boolean

Whether tool execution was successful

Defined in

packages/tools/src/index.ts:29


data

Optional data: T

Tool execution result data

Defined in

packages/tools/src/index.ts:34


error

Optional error: string

Error that occurred during tool execution

Defined in

packages/tools/src/index.ts:39


metadata

Optional metadata: Record<string, any>

Additional metadata

Defined in

packages/tools/src/index.ts:44

Released under the MIT License.