Commit 071fd5d
authored
docs: remove the nonexistent toolName field from tool.execution_complete (#2212)
The Node.js extension-authoring docs listed a `toolName` field on the
`tool.execution_complete` session event, in two event-field reference
tables and three handler code-comments. That event has no `toolName`:
`ToolExecutionCompleteData` declares `required: ["toolCallId","success"]`
with `additionalProperties: false` and no `toolName` property, so reading
`event.data.toolName` in a completion handler is always undefined.
`toolName` is emitted on `tool.execution_start`, and a completion is
correlated to its start by `toolCallId`.
Remove the field from the two `tool.execution_complete` rows and the three
completion-handler comments. It stays on the `tool.execution_start` rows.
The repository's shared event reference in docs/features/streaming-events.md
already documents the event without it.
Co-authored-by: examon <examon@users.noreply.github.com>1 parent 3b06ffd commit 071fd5d
2 files changed
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
258 | 258 | | |
259 | 259 | | |
260 | 260 | | |
261 | | - | |
| 261 | + | |
262 | 262 | | |
263 | 263 | | |
264 | 264 | | |
| |||
268 | 268 | | |
269 | 269 | | |
270 | 270 | | |
271 | | - | |
| 271 | + | |
272 | 272 | | |
273 | 273 | | |
274 | 274 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
368 | 368 | | |
369 | 369 | | |
370 | 370 | | |
371 | | - | |
| 371 | + | |
372 | 372 | | |
373 | 373 | | |
374 | 374 | | |
| |||
417 | 417 | | |
418 | 418 | | |
419 | 419 | | |
420 | | - | |
| 420 | + | |
421 | 421 | | |
422 | 422 | | |
423 | 423 | | |
| |||
677 | 677 | | |
678 | 678 | | |
679 | 679 | | |
680 | | - | |
| 680 | + | |
681 | 681 | | |
682 | 682 | | |
0 commit comments