Repository navigation
docs(unstable-v2): note that tool text can stream like message text - #2469
Merged
Merged
Conversation
The v2 tool-call docs described tool_call_content_chunk as streaming "complete" content items, which read as discouraging agents from streaming a tool's text in pieces the way they stream message text. Nothing in the append rules requires that: a chunk appends one item, and clients can present adjacent text items as continuous text, as they do for messages. Drop "complete" from the prompt-lifecycle walkthrough and add a non-normative note to Streaming Content, in both the published and draft v2 pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The v2 tool-call docs describe
tool_call_content_chunkas streaming "complete" content items, which reads as discouraging agents from streaming a tool's text in pieces the way they stream message text. The append rules don't require that: each chunk appends oneToolCallContentitem, exactly as message chunks append one content item, and clients can present adjacent text items as one continuous text.This drops "complete" from the prompt-lifecycle walkthrough and adds a non-normative note to the Streaming Content section of the tool-calls page, in both the published and draft v2 pages. It adds no requirement for clients or agents. Display-only terminal bytes remain
terminal_output_chunk, which the page already says.The v2 tool-call-updates RFD is left as written.