Documentation / @agentick/core / ProcedureEnvelope

Interface: ProcedureEnvelope<TArgs>

Defined in: kernel/src/procedure.ts:195

Metadata envelope passed to middleware containing execution context.

Example

const middleware: Middleware<[string]> = async (args, envelope, next) => {
  if (envelope.sourceType === 'hook') {
    console.log(`Hook ${envelope.operationName} from ${envelope.sourceId}`);
  }
  return next();
};

Type Parameters

TArgs

TArgs extends any[]

The argument types of the procedure

Properties

args

args: TArgs

Defined in: kernel/src/procedure.ts:203

The arguments passed to the procedure

---

context

context: KernelContext

Defined in: kernel/src/procedure.ts:205

The current kernel context

---

metadata?

optional metadata: Record<string, unknown>

Defined in: kernel/src/procedure.ts:207

Procedure metadata (tool names, model IDs, etc.)

---

operationName

operationName: string

Defined in: kernel/src/procedure.ts:201

Name of the operation being executed

---

sourceId?

optional sourceId: string

Defined in: kernel/src/procedure.ts:199

Identifier of the source (e.g., class name for decorated methods)

---

sourceType

sourceType: "procedure" | "hook"

Defined in: kernel/src/procedure.ts:197

Whether this is a regular procedure or a hook