Skip to content

docs: clarify the session/update variant set is not exhaustive - #1858

Open
somtri wants to merge 1 commit into
agentclientprotocol:mainfrom
somtri:docs/session-update-variant-set
Open

docs: clarify the session/update variant set is not exhaustive#1858
somtri wants to merge 1 commit into
agentclientprotocol:mainfrom
somtri:docs/session-update-variant-set

Conversation

@somtri

@somtri somtri commented Aug 3, 2026

Copy link
Copy Markdown

Fixes #1694.

The prompt-turn page walks a turn through five session/update variants, while schema/v1/schema.json defines eleven. Nothing marks the walkthrough as partial, so it reads as the full set.

Adds a Note pointing at the SessionUpdate schema reference, plus a short section in extensibility.mdx on unrecognized variants, which that page didn't cover. The draft/ copies get the same change, matching 8750b93.

Two calls worth flagging: I kept the extensibility wording advisory rather than SHOULD, since SessionUpdate is a closed oneOf with no catch-all. And v2 has the same gap (9 shown against 17) which I left alone, happy to add it here or in a follow-up.

The StopReason question in the issue is a separate protocol matter, untouched here.

The v1 prompt-turn page walks a turn through five session/update
variants while schema/v1/schema.json defines eleven, and nothing on
the page marks the walkthrough as partial. Point at the SessionUpdate
schema reference as the authoritative list, and cover unrecognized
variants on the extensibility page.

Refs agentclientprotocol#1694
@somtri
somtri requested a review from a team as a code owner August 3, 2026 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: prompt-turn page lists 5 SessionUpdate variants, schema v1 defines 11

1 participant