@agorio/sdkDocs


Interface: EnterprisePlugin

Extends

Properties

description

description: string

Description shown to the LLM for function calling

Inherited from

AgentPlugin.description

Defined in

src/types/index.ts:497


handler()

handler: (args) => unknown

Async handler that executes when the LLM calls this tool

Parameters

args: Record<string, unknown>

Returns

unknown

Inherited from

AgentPlugin.handler

Defined in

src/types/index.ts:501


manifest?

optional manifest: PluginManifest

Defined in

src/types/index.ts:532


name

name: string

Tool name the LLM will call (must not collide with built-in tools)

Inherited from

AgentPlugin.name

Defined in

src/types/index.ts:495


parameters

parameters: Record<string, unknown>

JSON Schema for the tool parameters

Inherited from

AgentPlugin.parameters

Defined in

src/types/index.ts:499

Methods

configure()?

optional configure(config): void

Parameters

config: Record<string, unknown>

Returns

void

Defined in

src/types/index.ts:546


getState()?

optional getState(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

src/types/index.ts:547


hydrate()?

optional hydrate(state): void

Optional — rehydrate from a snapshot previously returned by getState().

Parameters

state: Record<string, unknown>

Returns

void

Defined in

src/types/index.ts:549


onAfterToolCall()?

optional onAfterToolCall(toolName, args, result, context): void | Promise<void>

Parameters

toolName: string

args: Record<string, unknown>

result: unknown

context: PluginContext

Returns

void | Promise<void>

Defined in

src/types/index.ts:540


onBeforeToolCall()?

optional onBeforeToolCall(toolName, args, context): PluginToolDecision | Promise<PluginToolDecision>

Parameters

toolName: string

args: Record<string, unknown>

context: PluginContext

Returns

PluginToolDecision | Promise<PluginToolDecision>

Defined in

src/types/index.ts:535


onInit()?

optional onInit(context): void | Promise<void>

Parameters

context: PluginContext

Returns

void | Promise<void>

Defined in

src/types/index.ts:534


onRegister()?

optional onRegister(context): void

Parameters

context: PluginContext

Returns

void

Defined in

src/types/index.ts:533