agent-tools / Exports / OpenAPITool
Class: OpenAPITool
OpenAPI tool implementation Executes API calls based on OpenAPI 3.0 specifications
Implements ITool without extending AbstractTool to avoid circular runtime dependency (tools → agents → tools).
Implements
ITool
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new OpenAPITool(config): OpenAPITool
Parameters
| Name | Type |
|---|---|
config | IOpenAPIToolConfig |
Returns
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:33
Properties
schema
• Readonly schema: IToolSchema
Implementation of
ITool.schema
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:26
Methods
execute
▸ execute(parameters, context?): Promise<IToolResult>
Execute the OpenAPI tool
Parameters
| Name | Type |
|---|---|
parameters | TToolParameters |
context? | IToolExecutionContext |
Returns
Promise<IToolResult>
Implementation of
ITool.execute
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:55
validate
▸ validate(parameters): boolean
Validate tool parameters
Parameters
| Name | Type |
|---|---|
parameters | TToolParameters |
Returns
boolean
Implementation of
ITool.validate
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:107
validateParameters
▸ validateParameters(parameters): IParameterValidationResult
Validate tool parameters with detailed result
Parameters
| Name | Type |
|---|---|
parameters | TToolParameters |
Returns
IParameterValidationResult
Implementation of
ITool.validateParameters
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:114
getName
▸ getName(): string
Get tool name
Returns
string
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:133
setEventService
▸ setEventService(eventService): void
Set EventService for post-construction injection.
Parameters
| Name | Type |
|---|---|
eventService | undefined | IEventService |
Returns
void
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:140
getDescription
▸ getDescription(): string
Get tool description
Returns
string
Implementation of
ITool.getDescription
Defined in
packages/agent-tools/src/implementations/openapi-tool.ts:147