agents / Exports / ToolResult

Interface: ToolResult

Tool execution result - extended for ToolExecutionData compatibility

REASON: Added index signature for compatibility with Record-based ToolExecutionData types ALTERNATIVES_CONSIDERED:

1. Create separate conversion functions (adds unnecessary complexity)
2. Use union types with type guards (increases runtime overhead)
3. Modify ToolExecutionData to exclude Record types (breaks existing functionality)
4. Use type assertions at every usage site (decreases type safety) TODO: Consider creating a stricter ToolResult variant if index signature causes issues

Indexable

▪ [key: string]: string | number | boolean | ToolParameters | ToolExecutionData | ToolMetadata | undefined

Table of contents

Properties

• success
• data
• error
• metadata

Properties

success

• success: boolean

Defined in

packages/agents/src/interfaces/tool.ts:62

---

data

• Optional data: ToolExecutionData

Defined in

packages/agents/src/interfaces/tool.ts:63

---

error

• Optional error: string

Defined in

packages/agents/src/interfaces/tool.ts:64

---

metadata

• Optional metadata: ToolMetadata

Defined in

packages/agents/src/interfaces/tool.ts:65