Skip to content

agent-core / Exports / IToolWithEventService

Interface: IToolWithEventService<TParameters, TResult>

Runtime tool instance contract used by Robota internals.

Tools passed into Agent configuration must support EventService injection so Robota can emit unified tool lifecycle events.

Type parameters

NameType
TParametersTToolParameters
TResultIToolResult

Hierarchy

Implemented by

Table of contents

Properties

Methods

Properties

schema

Readonly schema: IToolSchema

Inherited from

IToolContract.schema

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:93

Methods

execute

execute(parameters, context): Promise<TResult>

Parameters

NameType
parametersTParameters
contextIToolExecutionContext

Returns

Promise<TResult>

Inherited from

IToolContract.execute

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:94


validate

validate(parameters): boolean

Parameters

NameType
parametersTParameters

Returns

boolean

Inherited from

IToolContract.validate

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:95


validateParameters

validateParameters(parameters): IParameterValidationResult

Parameters

NameType
parametersTParameters

Returns

IParameterValidationResult

Inherited from

IToolContract.validateParameters

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:96


getDescription

getDescription(): string

Returns

string

Inherited from

IToolContract.getDescription

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:97


getName

getName(): string

Returns

string

Inherited from

IToolContract.getName

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:98


setEventService

setEventService(eventService): void

Parameters

NameType
eventServiceundefined | IEventService

Returns

void

Defined in

packages/agent-core/src/abstracts/abstract-tool.ts:109

Released under the MIT License.