Skip to main content

Tool

@codebolt/agent

Class: Tool

Defined in: packages/agent/src/unified/agent/tools.ts:9

Implements​

  • ToolInterface

Constructors​

Constructor​

new Tool(config: ToolConfig): Tool;

Defined in: packages/agent/src/unified/agent/tools.ts:16

Parameters​

ParameterType
configToolConfig

Returns​

Tool

Properties​

PropertyTypeDefined in
descriptionstringpackages/agent/src/unified/agent/tools.ts:11
executionFunction(context: unknown) => unknownpackages/agent/src/unified/agent/tools.ts:14
idstringpackages/agent/src/unified/agent/tools.ts:10
inputSchemaZodTypepackages/agent/src/unified/agent/tools.ts:12
outputSchema?ZodType<any, ZodTypeDef, any>packages/agent/src/unified/agent/tools.ts:13

Methods​

execute()​

execute(input: unknown, context: unknown): Promise<{
  error?: string;
  result?: unknown;
  success: boolean;
}>;

Defined in: packages/agent/src/unified/agent/tools.ts:23

Parameters​

ParameterType
inputunknown
contextunknown

Returns​

Promise<{ error?: string; result?: unknown; success: boolean; }>

Implementation of​

ToolInterface.execute

getToolDescription()​

getToolDescription(): string;

Defined in: packages/agent/src/unified/agent/tools.ts:54

Returns​

string

Implementation of​

ToolInterface.getToolDescription

getToolSchema()​

getToolSchema(): ZodType<any, ZodTypeDef, any>;

Defined in: packages/agent/src/unified/agent/tools.ts:57

Returns​

ZodType<any, ZodTypeDef, any>

Implementation of​

ToolInterface.getToolSchema

toOpenAITool()​

toOpenAITool(): OpenAITool;

Defined in: packages/agent/src/unified/agent/tools.ts:116

Converts the tool to OpenAI function format

Returns​

OpenAITool

OpenAI function specification