Skip to content

Commit 11bda33

Browse files
committed
Clean up docs
1 parent 2a116d8 commit 11bda33

11 files changed

Lines changed: 20 additions & 431 deletions

docs/docs.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@
9494
"protocol/v2/file-system",
9595
"protocol/v2/terminals",
9696
"protocol/v2/agent-plan",
97-
"protocol/v2/session-modes",
9897
"protocol/v2/session-config-options",
9998
"protocol/v2/slash-commands",
10099
"protocol/v2/extensibility",
@@ -117,7 +116,6 @@
117116
"protocol/v2/draft/cancellation",
118117
"protocol/v2/draft/terminals",
119118
"protocol/v2/draft/agent-plan",
120-
"protocol/v2/draft/session-modes",
121119
"protocol/v2/draft/session-config-options",
122120
"protocol/v2/draft/slash-commands",
123121
"protocol/v2/draft/extensibility",

docs/protocol/v2/draft/overview.mdx

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,6 @@ Agents are programs that use generative AI to autonomously modify code. They typ
8989
`agentCapabilities.auth.logout` capability).
9090
</ResponseField>
9191

92-
<ResponseField
93-
name="session/set_mode"
94-
post={[<a href="./schema#session%2Fset-mode">Schema</a>]}
95-
>
96-
[Switch between agent operating
97-
modes](./session-modes#setting-the-current-mode).
98-
</ResponseField>
99-
10092
### Notifications
10193

10294
<ResponseField
@@ -181,11 +173,11 @@ Clients provide the interface between users and agents. They are typically code
181173
post={[<a href="./schema#session%2Fupdate">Schema</a>]}
182174
>
183175
[Send session updates](./prompt-turn#3-agent-reports-output) to inform the
184-
Client of changes (no response expected). This includes: - [Message
185-
chunks](./content) (agent, user, thought) - [Tool calls and
186-
updates](./tool-calls) - [Plans](./agent-plan) - [Available commands
187-
updates](./slash-commands#advertising-commands) - [Mode
188-
changes](./session-modes#from-the-agent)
176+
Client of changes (no response expected). This includes [message
177+
chunks](./content), [tool calls and updates](./tool-calls),
178+
[plans](./agent-plan), [available commands
179+
updates](./slash-commands#advertising-commands), and [config option
180+
updates](./session-config-options#from-the-agent).
189181
</ResponseField>
190182

191183
## Argument requirements

docs/protocol/v2/draft/session-config-options.mdx

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@ title: "Session Config Options"
33
description: "Flexible configuration selectors for agent sessions"
44
---
55

6-
Agents can provide an arbitrary list of configuration options for a session, allowing Clients to offer users customizable selectors for things like models, modes, reasoning levels, and more.
7-
8-
<Info>
9-
Session Config Options are the preferred way to expose session-level
10-
configuration. If an Agent provides `configOptions`, Clients **SHOULD** use
11-
them instead of the [`modes`](./session-modes) field. Modes will be removed in
12-
a future version of the protocol.
13-
</Info>
6+
Agents can provide an arbitrary list of configuration options for a session, allowing Clients to offer users customizable selectors for things like modes, models, reasoning levels, and more.
147

158
## Initial State
169

@@ -263,20 +256,3 @@ This notification also contains the complete configuration state. Common reasons
263256
- Switching modes after completing a planning phase
264257
- Falling back to a different model due to rate limits or errors
265258
- Adjusting available options based on context discovered during execution
266-
267-
## Relationship to Session Modes
268-
269-
Session Config Options supersede the older [Session Modes](./session-modes) API. However, during the transition period, Agents that provide mode-like configuration **SHOULD** send both:
270-
271-
- `configOptions` with a `category: "mode"` option for Clients that support config options
272-
- `modes` for Clients that only support the older API
273-
274-
If an Agent provides both `configOptions` and `modes` in the session response:
275-
276-
- Clients that support config options **SHOULD** use `configOptions` exclusively and ignore `modes`
277-
- Clients that don't support config options **SHOULD** fall back to `modes`
278-
- Agents **SHOULD** keep both in sync to ensure consistent behavior regardless of which field the Client uses
279-
280-
<Card icon="gears" horizontal href="../session-modes">
281-
Learn about the Session Modes API
282-
</Card>

docs/protocol/v2/draft/session-list.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ When no sessions match the criteria, the Agent **MUST** return an empty `session
179179

180180
## Updating Session Metadata
181181

182-
Agents can update session metadata in real-time by sending a `session_info_update` notification via `session/update`. This follows the same pattern as other session notifications like [`available_commands_update`](/protocol/v2/draft/slash-commands) and [`current_mode_update`](/protocol/v2/draft/session-modes).
182+
Agents can update session metadata in real-time by sending a `session_info_update` notification via `session/update`. This follows the same pattern as other session notifications like [`available_commands_update`](/protocol/v2/draft/slash-commands) and [`config_option_update`](/protocol/v2/draft/session-config-options#from-the-agent).
183183

184184
```json
185185
{

docs/protocol/v2/draft/session-modes.mdx

Lines changed: 0 additions & 173 deletions
This file was deleted.

docs/protocol/v2/draft/session-setup.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@ Agent **MUST** respond to the original `session/load` request.
184184
}
185185
```
186186

187-
The response **MAY** also include initial mode, model, or session configuration
188-
state when those features are supported by the Agent.
187+
The response **MAY** also include initial session configuration state when that
188+
feature is supported by the Agent.
189189

190190
The Client can then continue sending prompts as if the session was never
191191
interrupted.
@@ -261,8 +261,8 @@ session is ready to continue.
261261
}
262262
```
263263

264-
The response **MAY** also include initial mode, model, or session configuration
265-
state when those features are supported by the Agent.
264+
The response **MAY** also include initial session configuration state when that
265+
feature is supported by the Agent.
266266

267267
## Closing Active Sessions
268268

docs/protocol/v2/overview.mdx

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,6 @@ Agents are programs that use generative AI to autonomously modify code. They typ
8989
`agentCapabilities.auth.logout` capability).
9090
</ResponseField>
9191

92-
<ResponseField
93-
name="session/set_mode"
94-
post={[<a href="./schema#session%2Fset-mode">Schema</a>]}
95-
>
96-
[Switch between agent operating
97-
modes](./session-modes#setting-the-current-mode).
98-
</ResponseField>
99-
10092
### Notifications
10193

10294
<ResponseField
@@ -181,11 +173,11 @@ Clients provide the interface between users and agents. They are typically code
181173
post={[<a href="./schema#session%2Fupdate">Schema</a>]}
182174
>
183175
[Send session updates](./prompt-turn#3-agent-reports-output) to inform the
184-
Client of changes (no response expected). This includes: - [Message
185-
chunks](./content) (agent, user, thought) - [Tool calls and
186-
updates](./tool-calls) - [Plans](./agent-plan) - [Available commands
187-
updates](./slash-commands#advertising-commands) - [Mode
188-
changes](./session-modes#from-the-agent)
176+
Client of changes (no response expected). This includes [message
177+
chunks](./content), [tool calls and updates](./tool-calls),
178+
[plans](./agent-plan), [available commands
179+
updates](./slash-commands#advertising-commands), and [config option
180+
updates](./session-config-options#from-the-agent).
189181
</ResponseField>
190182

191183
## Argument requirements

docs/protocol/v2/session-config-options.mdx

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@ title: "Session Config Options"
33
description: "Flexible configuration selectors for agent sessions"
44
---
55

6-
Agents can provide an arbitrary list of configuration options for a session, allowing Clients to offer users customizable selectors for things like models, modes, reasoning levels, and more.
7-
8-
<Info>
9-
Session Config Options are the preferred way to expose session-level
10-
configuration. If an Agent provides `configOptions`, Clients **SHOULD** use
11-
them instead of the [`modes`](./session-modes) field. Modes will be removed in
12-
a future version of the protocol.
13-
</Info>
6+
Agents can provide an arbitrary list of configuration options for a session, allowing Clients to offer users customizable selectors for things like modes, models, reasoning levels, and more.
147

158
## Initial State
169

@@ -263,20 +256,3 @@ This notification also contains the complete configuration state. Common reasons
263256
- Switching modes after completing a planning phase
264257
- Falling back to a different model due to rate limits or errors
265258
- Adjusting available options based on context discovered during execution
266-
267-
## Relationship to Session Modes
268-
269-
Session Config Options supersede the older [Session Modes](./session-modes) API. However, during the transition period, Agents that provide mode-like configuration **SHOULD** send both:
270-
271-
- `configOptions` with a `category: "mode"` option for Clients that support config options
272-
- `modes` for Clients that only support the older API
273-
274-
If an Agent provides both `configOptions` and `modes` in the session response:
275-
276-
- Clients that support config options **SHOULD** use `configOptions` exclusively and ignore `modes`
277-
- Clients that don't support config options **SHOULD** fall back to `modes`
278-
- Agents **SHOULD** keep both in sync to ensure consistent behavior regardless of which field the Client uses
279-
280-
<Card icon="gears" horizontal href="../session-modes">
281-
Learn about the Session Modes API
282-
</Card>

docs/protocol/v2/session-list.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ When no sessions match the criteria, the Agent **MUST** return an empty `session
156156

157157
## Updating Session Metadata
158158

159-
Agents can update session metadata in real-time by sending a `session_info_update` notification via `session/update`. This follows the same pattern as other session notifications like [`available_commands_update`](./slash-commands) and [`current_mode_update`](./session-modes).
159+
Agents can update session metadata in real-time by sending a `session_info_update` notification via `session/update`. This follows the same pattern as other session notifications like [`available_commands_update`](./slash-commands) and [`config_option_update`](./session-config-options#from-the-agent).
160160

161161
```json
162162
{

0 commit comments

Comments
 (0)