AfterToolCallEvent
Defined in: src/hooks/events.ts:256
Event triggered after a tool execution completes. Fired after tool execution finishes, whether successful or failed. Uses reverse callback ordering for proper cleanup semantics.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AfterToolCallEvent(data): AfterToolCallEvent;Defined in: src/hooks/events.ts:281
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; toolUse: { name: string; toolUseId: string; input: JSONValue; }; tool: Tool; result: ToolResultBlock; invocationState: InvocationState; error?: Error; } |
data.agent | LocalAgent |
data.toolUse | { name: string; toolUseId: string; input: JSONValue; } |
data.toolUse.name | string |
data.toolUse.toolUseId | string |
data.toolUse.input | JSONValue |
data.tool | Tool |
data.result | ToolResultBlock |
data.invocationState | InvocationState |
data.error? | Error |
Returns
Section titled “Returns”AfterToolCallEvent
Overrides
Section titled “Overrides”Properties
Section titled “Properties”readonly type: "afterToolCallEvent";Defined in: src/hooks/events.ts:257
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:258
toolUse
Section titled “toolUse”readonly toolUse: { name: string; toolUseId: string; input: JSONValue;};Defined in: src/hooks/events.ts:259
name: string;toolUseId
Section titled “toolUseId”toolUseId: string;input: JSONValue;readonly tool: Tool;Defined in: src/hooks/events.ts:264
result
Section titled “result”result: ToolResultBlock;Defined in: src/hooks/events.ts:270
The tool result. Can be replaced by hook callbacks to transform the result before it enters the conversation history.
error?
Section titled “error?”readonly optional error?: Error;Defined in: src/hooks/events.ts:272
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/hooks/events.ts:273
retry?
Section titled “retry?”optional retry?: boolean;Defined in: src/hooks/events.ts:279
Optional flag that can be set by hook callbacks to request a retry of the tool call. When set to true, the agent will re-execute the tool.
Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): Pick<AfterToolCallEvent, "toolUse" | "type" | "result"> & { error?: { message?: string; };};Defined in: src/hooks/events.ts:309
Serializes for wire transport, excluding the agent reference, tool instance, invocationState, and mutable retry flag. Converts Error to an extensible object for safe wire serialization. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Pick<AfterToolCallEvent, "toolUse" | "type" | "result"> & {
error?: {
message?: string;
};
}