@agorio/sdk • Docs
Interface: EnterprisePlugin
Extends
Properties
description
description:
string
Description shown to the LLM for function calling
Inherited from
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
Defined in
src/types/index.ts:501
manifest?
optionalmanifest: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
Defined in
src/types/index.ts:495
parameters
parameters:
Record<string,unknown>
JSON Schema for the tool parameters
Inherited from
Defined in
src/types/index.ts:499
Methods
configure()?
optionalconfigure(config):void
Parameters
• config: Record<string, unknown>
Returns
void
Defined in
src/types/index.ts:546
getState()?
optionalgetState():Record<string,unknown>
Returns
Record<string, unknown>
Defined in
src/types/index.ts:547
hydrate()?
optionalhydrate(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()?
optionalonAfterToolCall(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()?
optionalonBeforeToolCall(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()?
optionalonInit(context):void|Promise<void>
Parameters
• context: PluginContext
Returns
void | Promise<void>
Defined in
src/types/index.ts:534
onRegister()?
optionalonRegister(context):void
Parameters
• context: PluginContext
Returns
void
Defined in
src/types/index.ts:533