agent-core / Exports / IToolContract
Interface: IToolContract<TParameters, TResult>
Type-safe tool interface with type parameters
Type parameters
| Name | Type | Description |
|---|---|---|
TParameters | TToolParameters | Tool parameters type (defaults to AbstractToolParameters for backward compatibility) |
TResult | IToolResult | Tool result type (defaults to ToolResult for backward compatibility) |
Hierarchy
IToolContract
Table of contents
Properties
Methods
Properties
schema
• Readonly schema: IToolSchema
Defined in
packages/agent-core/src/abstracts/abstract-tool.ts:93
Methods
execute
▸ execute(parameters, context): Promise<TResult>
Parameters
| Name | Type |
|---|---|
parameters | TParameters |
context | IToolExecutionContext |
Returns
Promise<TResult>
Defined in
packages/agent-core/src/abstracts/abstract-tool.ts:94
validate
▸ validate(parameters): boolean
Parameters
| Name | Type |
|---|---|
parameters | TParameters |
Returns
boolean
Defined in
packages/agent-core/src/abstracts/abstract-tool.ts:95
validateParameters
▸ validateParameters(parameters): IParameterValidationResult
Parameters
| Name | Type |
|---|---|
parameters | TParameters |
Returns
Defined in
packages/agent-core/src/abstracts/abstract-tool.ts:96
getDescription
▸ getDescription(): string
Returns
string
Defined in
packages/agent-core/src/abstracts/abstract-tool.ts:97
getName
▸ getName(): string
Returns
string