Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
somtri wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −0
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/protocol/v1/draft/extensibility.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,7 @@ Implementations **SHOULD** use the `_meta` field in capability objects to advert
```

This allows implementations to negotiate custom features during initialization without breaking compatibility with standard Clients and Agents.

## Unrecognized Session Update Variants

Every `session/update` notification carries a `sessionUpdate` field that identifies the variant. Future protocol versions may define new variants. Clients are encouraged to ignore variants they do not recognize rather than treating them as errors. The [`SessionUpdate`](/protocol/v1/draft/schema#sessionupdate) schema reference lists the variants defined in this version.
7 changes: 7 additions & 0 deletions docs/protocol/v1/draft/prompt-turn.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@ Upon receiving the prompt request, the Agent processes the user's message and se

The Agent reports the model's output to the Client via `session/update` notifications. This may include the Agent's plan for accomplishing the task:

<Note>
This page walks through the `session/update` variants most common in a prompt
turn. It is not the full set. See the
[`SessionUpdate`](/protocol/v1/draft/schema#sessionupdate) schema reference
for every variant defined in this version.
</Note>

```json expandable
{
"jsonrpc": "2.0",
Expand Down
4 changes: 4 additions & 0 deletions docs/protocol/v1/extensibility.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,7 @@ Implementations **SHOULD** use the `_meta` field in capability objects to advert
```

This allows implementations to negotiate custom features during initialization without breaking compatibility with standard Clients and Agents.

## Unrecognized Session Update Variants

Every `session/update` notification carries a `sessionUpdate` field that identifies the variant. Future protocol versions may define new variants. Clients are encouraged to ignore variants they do not recognize rather than treating them as errors. The [`SessionUpdate`](/protocol/v1/schema#sessionupdate) schema reference lists the variants defined in this version.
7 changes: 7 additions & 0 deletions docs/protocol/v1/prompt-turn.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@ Upon receiving the prompt request, the Agent processes the user's message and se

The Agent reports the model's output to the Client via `session/update` notifications. This may include the Agent's plan for accomplishing the task:

<Note>
This page walks through the `session/update` variants most common in a prompt
turn. It is not the full set. See the
[`SessionUpdate`](/protocol/v1/schema#sessionupdate) schema reference for
every variant defined in this version.
</Note>

```json expandable
{
"jsonrpc": "2.0",
Expand Down