agents / Exports / ToolInterface
Interface: ToolInterface
Base tool interface
Implemented by
Table of contents
Properties
Methods
Properties
schema
• schema: ToolSchema
Tool schema
Defined in
packages/agents/src/interfaces/tool.ts:178
Methods
execute
▸ execute(parameters, context?): Promise<ToolResult>
Execute the tool with given parameters
Parameters
| Name | Type |
|---|---|
parameters | ToolParameters |
context? | ToolExecutionContext |
Returns
Promise<ToolResult>
Defined in
packages/agents/src/interfaces/tool.ts:183
validate
▸ validate(parameters): boolean
Validate tool parameters
Parameters
| Name | Type |
|---|---|
parameters | ToolParameters |
Returns
boolean
Defined in
packages/agents/src/interfaces/tool.ts:188
validateParameters
▸ validateParameters(parameters): ParameterValidationResult
Validate tool parameters with detailed result
Parameters
| Name | Type |
|---|---|
parameters | ToolParameters |
Returns
Defined in
packages/agents/src/interfaces/tool.ts:193
getDescription
▸ getDescription(): string
Get tool description
Returns
string