agent-core / Exports / IFunctionTool

Interface: IFunctionTool

Function tool implementation

Hierarchy

• ITool

  ↳ IFunctionTool

Table of contents

Properties

• schema
• fn

Methods

• execute
• validate
• validateParameters
• getDescription

Properties

schema

• schema: IToolSchema

Tool schema

Inherited from

ITool.schema

Defined in

packages/agent-core/src/interfaces/tool.ts:215

---

fn

• fn: TToolExecutor<TToolParameters, TUniversalValue>

Function to execute

Defined in

packages/agent-core/src/interfaces/tool.ts:243

Methods

execute

▸ execute(parameters, context?): Promise<IToolResult>

Execute the tool with given parameters

Parameters

Name	Type
parameters	TToolParameters
context?	IToolExecutionContext

Returns

Promise<IToolResult>

Inherited from

ITool.execute

Defined in

packages/agent-core/src/interfaces/tool.ts:220

---

validate

▸ validate(parameters): boolean

Validate tool parameters

Parameters

Name	Type
parameters	TToolParameters

Returns

boolean

Inherited from

ITool.validate

Defined in

packages/agent-core/src/interfaces/tool.ts:225

---

validateParameters

▸ validateParameters(parameters): IParameterValidationResult

Validate tool parameters with detailed result

Parameters

Name	Type
parameters	TToolParameters

Returns

IParameterValidationResult

Inherited from

ITool.validateParameters

Defined in

packages/agent-core/src/interfaces/tool.ts:230

---

getDescription

▸ getDescription(): string

Get tool description

Returns

string

Inherited from

ITool.getDescription

Defined in

packages/agent-core/src/interfaces/tool.ts:235