agents / Exports / LegacyBaseTool
Class: LegacyBaseTool
Legacy tool class for backward compatibility
Deprecated
Use BaseTool with type parameters instead
Hierarchy
BaseTool<BaseToolParameters,ToolResult>↳
LegacyBaseTool
Implements
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new LegacyBaseTool(): LegacyBaseTool
Returns
Inherited from
Properties
schema
• Readonly Abstract schema: ToolSchema
Tool schema
Implementation of
Inherited from
Defined in
packages/agents/src/abstracts/base-tool.ts:74
Methods
execute
▸ execute(parameters, context?): Promise<ToolResult>
Execute the tool with given parameters
Parameters
| Name | Type |
|---|---|
parameters | BaseToolParameters |
context? | ToolExecutionContext |
Returns
Promise<ToolResult>
Implementation of
Inherited from
Defined in
packages/agents/src/abstracts/base-tool.ts:76
validate
▸ validate(parameters): boolean
Validate tool parameters
Parameters
| Name | Type |
|---|---|
parameters | BaseToolParameters |
Returns
boolean
Implementation of
Inherited from
Defined in
packages/agents/src/abstracts/base-tool.ts:78
validateParameters
▸ validateParameters(parameters): ParameterValidationResult
Validate tool parameters with detailed result (default implementation)
Parameters
| Name | Type |
|---|---|
parameters | BaseToolParameters |
Returns
Implementation of
ToolInterface.validateParameters
Inherited from
Defined in
packages/agents/src/abstracts/base-tool.ts:86
getDescription
▸ getDescription(): string
Get tool description
Returns
string
Implementation of
Inherited from
Defined in
packages/agents/src/abstracts/base-tool.ts:103
getName
▸ getName(): string
Returns
string