ToolActivityData
One tool starting, completing, or failing during the turn.
What chat’s on_tool_activity callback receives. Expect two events per tool
call — started, then completed or failed — sharing one id.
Properties
Section titled “Properties”| Property | Type | Default | Description |
|---|---|---|---|
conversation_id |
str |
— | The conversation the turn runs in. |
stream_id |
str |
— | Equals turn_id. |
turn_id |
str |
— | The turn this activity belongs to. |
id |
str |
— | The tool_use id — pairs a completion with its start. |
tool |
str |
— | Friendly tool name, with the MCP namespace stripped — the one to display. |
tool_full |
str |
— | Original namespaced tool name, for filtering or audit. |
status |
Literal['started', 'completed', 'failed'] |
— | Where the call is: started opens it, completed or failed closes it. |
input |
JsonValue |
None |
The arguments the agent called the tool with, when the event carries them. |
result |
JsonValue |
None |
Raw tool result — unbounded, and not meant for direct display. |
is_error |
bool | None |
None |
Whether the tool reported its result as an error. |
error |
str | None |
None |
The error text, on a failed event. |