agents / Exports / BaseToolInterface
Interface: BaseToolInterface<TParams, TResult>
Base tool interface with type parameters for enhanced type safety
Type parameters
| Name | Type | Description |
|---|---|---|
TParams | BaseToolParameters | Tool parameters type (defaults to BaseToolParameters for backward compatibility) |
TResult | ToolResult | Tool result type (defaults to ToolResult for backward compatibility) |
Table of contents
Properties
Properties
name
• name: string
Defined in
packages/agents/src/abstracts/base-tool.ts:44
description
• description: string
Defined in
packages/agents/src/abstracts/base-tool.ts:45
parameters
• parameters: Object
Type declaration
| Name | Type |
|---|---|
type | "object" |
properties | Record<string, ParameterSchema> |
required? | string[] |
Defined in
packages/agents/src/abstracts/base-tool.ts:46
execute
• execute: ToolExecutionFunction<TParams, TResult>