Repository navigation
docs(unstable-v2): cover background work and cancel controls in the migration guide - #2866
Merged
Merged
Conversation
…igration guide The migration guide never mentioned `tool_call/cancel` or the `paused` status, left `capabilities` out of the tool call and terminal fields, and did not describe the `background` list. Both checklists said terminals have no Client controls, which contradicts `terminal/cancel`. - Add `tool_call/cancel` and `terminal/cancel` to the method table, and `paused`, `capabilities`, and the `background` list to the update table. - Add a "Background work and cancel controls" section under Tool calls. - Say that the `status` enum adds `paused`, and that `capabilities` is a patch field on `terminal_update`. - Fix the two terminal checklist items, add the permission change to the Client cancellation item, and add a background work item to each checklist. Migration guide only. The spec pages already define all of this.
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.
Adds the Background Work additions to the migration guide.
The guide never mentioned
tool_call/cancelor thepausedstatus. It leftcapabilitiesout of the tool call and terminal fields, and did not describe thebackgroundlist onstate_update. Both checklists said terminals have no Client controls, which contradictsterminal/cancel. A Client built from the guide never offers to stop a tool call and treatspausedas an unknown status.Migration guide only. The tool calls and prompt lifecycle pages already define all of this.
Changes
tool_call/cancelandterminal/cancel.tool_call_updategains thepausedstatus and thecapabilitiesfield.state_updatecarries an optionalbackgroundlist.backgroundlist, thepausedstatus,capabilities.cancelwith the two cancel methods, and whatsession/cancelandsession/closedo with listed work.statusenum addspausedas well ascancelled, andcapabilitiesis a patch field onterminal_update.session/cancel.Checks
Prettier and
typospass, and all internal links in the migration guide resolve.