Skip to content

Interface: GroupAction<TContext>

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

A single action definition within a group.

Type Parameters

Type Parameter
TContext

Properties

description?

ts
readonly optional description: string;

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

Human-readable description for the LLM


destructive?

ts
readonly optional destructive: boolean;

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

Mark as destructive


handler()

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

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

Handler function

Parameters

ParameterType
ctxTContext
argsRecord<string, unknown>

Returns

Promise<ToolResponse>


idempotent?

ts
readonly optional idempotent: boolean;

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

Mark as idempotent


middleware?

ts
readonly optional middleware: MiddlewareFn<TContext>[];

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

Per-action middleware


readOnly?

ts
readonly optional readOnly: boolean;

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

Mark as read-only


schema?

ts
readonly optional schema: ZodObject<ZodRawShape, UnknownKeysParam, ZodTypeAny, {
[key: string]: any;
}, {
[key: string]: any;
}>;

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

Zod schema for input validation