Skip to content

Interface: CompiledGroup<TContext>

Defined in: packages/core/src/core/createGroup.ts:89

A compiled, frozen group ready for execution.

Type Parameters

Type Parameter
TContext

Properties

actionNames

ts
readonly actionNames: readonly string[];

Defined in: packages/core/src/core/createGroup.ts:97

List of action names


description

ts
readonly description: string | undefined;

Defined in: packages/core/src/core/createGroup.ts:93

Description


execute()

ts
readonly execute: (ctx, action, args) => Promise<ToolResponse>;

Defined in: packages/core/src/core/createGroup.ts:107

Execute an action by name.

Parameters

ParameterTypeDescription
ctxTContextApplication context
actionstringAction name
argsRecord<string, unknown>Input arguments

Returns

Promise<ToolResponse>

Tool response

Throws

If action name is unknown


getAction()

ts
readonly getAction: (name) => Readonly<GroupAction<TContext>> | undefined;

Defined in: packages/core/src/core/createGroup.ts:111

Get metadata for a specific action.

Parameters

ParameterType
namestring

Returns

Readonly<GroupAction<TContext>> | undefined


name

ts
readonly name: string;

Defined in: packages/core/src/core/createGroup.ts:91

Group/tool name


tags

ts
readonly tags: readonly string[];

Defined in: packages/core/src/core/createGroup.ts:95

Tags