Skip to content

tools / Exports / ToolRegistry

Class: ToolRegistry

Tool registry class

Class for registering and managing multiple tools

Table of contents

Constructors

Methods

Constructors

constructor

new ToolRegistry(): ToolRegistry

Returns

ToolRegistry

Methods

register

register(tool): ToolRegistry

Register a tool

Parameters

NameTypeDescription
toolTool<any, any>Tool to register

Returns

ToolRegistry

Defined in

packages/tools/src/index.ts:176


registerMany

registerMany(tools): ToolRegistry

Register multiple tools

Parameters

NameTypeDescription
toolsTool<any, any>[]Array of tools to register

Returns

ToolRegistry

Defined in

packages/tools/src/index.ts:186


getTool

getTool(name): undefined | Tool<any, any>

Get a tool

Parameters

NameTypeDescription
namestringName of the tool to get

Returns

undefined | Tool<any, any>

Tool or undefined

Defined in

packages/tools/src/index.ts:199


getAllTools

getAllTools(): Tool<any, any>[]

Get all tools

Returns

Tool<any, any>[]

Array of all registered tools

Defined in

packages/tools/src/index.ts:208


executeTool

executeTool<TInput, TOutput>(name, input): Promise<ToolResult<TOutput>>

Execute a tool

Type parameters

NameType
TInputany
TOutputany

Parameters

NameTypeDescription
namestringName of the tool to execute
inputTInputTool input parameters

Returns

Promise<ToolResult<TOutput>>

Tool execution result

Defined in

packages/tools/src/index.ts:219

Released under the MIT License.