ExecuteToolContext
Defined in: src/middleware/stages.ts:116
Context passed to tool-stage middleware. Contains everything needed to understand and potentially modify the tool call.
Extends
Section titled “Extends”Properties
Section titled “Properties”readonly agent: LocalAgent;Defined in: src/middleware/stages.ts:118
The agent instance (escape hatch for advanced use cases).
readonly tool: Tool;Defined in: src/middleware/stages.ts:120
The resolved tool implementation, or undefined if not found.
toolUse
Section titled “toolUse”readonly toolUse: ToolUseData;Defined in: src/middleware/stages.ts:122
The tool use request (name, toolUseId, input).
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/middleware/stages.ts:124
Per-invocation state. Shared by reference — mutations are visible to hooks, tools, and AgentResult.
cancelSignal
Section titled “cancelSignal”readonly cancelSignal: AbortSignal;Defined in: src/middleware/stages.ts:126
Executor-owned cancellation signal for this tool call; middleware can observe but cannot replace it.
Methods
Section titled “Methods”interrupt()
Section titled “interrupt()”interrupt<T>(params): MiddlewareInterruptResult<T>;Defined in: src/middleware/stages.ts:50
Request a human-in-the-loop interrupt.
On first execution (no prior response), throws InterruptError to halt the agent.
On resume (after the user provides a response), returns the response wrapped in
MiddlewareInterruptResult.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | JSONValue |
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
params | InterruptParams | Interrupt parameters (name, optional reason, optional preemptive response) |
Returns
Section titled “Returns”The user’s response wrapped in { response: T }
Throws
Section titled “Throws”InterruptError when no response has been provided yet