Open History to see the last commit
Interface: ToolExecutionContext#
Defined in: packages/typescript/ai/src/types.ts:449
Context passed to tool execute functions, providing capabilities like emitting custom events during execution.
Properties#
emitCustomEvent()#
emitCustomEvent: (eventName, value) => void;
Defined in: packages/typescript/ai/src/types.ts:470
Emit a custom event during tool execution. Events are streamed to the client in real-time as AG-UI CUSTOM events.
Parameters#
eventName#
string
Name of the custom event
value#
Record<string, any>
Event payload value
Returns#
void
Example#
const tool = toolDefinition({ ... }).server(async (args, context) => {
context?.emitCustomEvent('progress', { step: 1, total: 3 })
// ... do work ...
context?.emitCustomEvent('progress', { step: 2, total: 3 })
// ... do more work ...
return result
})
toolCallId?#
optional toolCallId: string;
Defined in: packages/typescript/ai/src/types.ts:451
The ID of the tool call being executed