<!--
 ⚠️  AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
 This file is automatically generated by scripts/docs-generator.js
 To make changes, edit the source TypeScript files or update the generator script
-->

[agents](../../) / [Exports](../modules) / IToolResult

# Interface: IToolResult

Tool execution result - extended for ToolExecutionData compatibility

## Indexable

▪ [key: `string`]: `TToolContextExtensionValue` \| `undefined`

## Table of contents

### Properties

- [success](IToolResult#success)
- [data](IToolResult#data)
- [error](IToolResult#error)
- [metadata](IToolResult#metadata)

## Properties

### success

• **success**: `boolean`

#### Defined in

[packages/agents/src/interfaces/tool.ts:34](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/tool.ts#L34)

---

### data

• `Optional` **data**: [`TUniversalValue`](../modules#tuniversalvalue)

#### Defined in

[packages/agents/src/interfaces/tool.ts:35](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/tool.ts#L35)

---

### error

• `Optional` **error**: `string`

#### Defined in

[packages/agents/src/interfaces/tool.ts:36](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/tool.ts#L36)

---

### metadata

• `Optional` **metadata**: [`TToolMetadata`](../modules#ttoolmetadata)

#### Defined in

[packages/agents/src/interfaces/tool.ts:37](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/tool.ts#L37)
