docs: correct stale type/field names, actions, and wire shapes in the guides#312
Merged
connor4312 merged 6 commits intoJul 8, 2026
Merged
Conversation
… guides Doc-vs-types drift found while verifying the guides against types/*.ts, independent of the multi-chat (microsoft#213) channel move: - Type/field names: ModelInfo -> SessionModelInfo; UserMessage -> Message; ContentRef.mimeType -> contentType; AgentInfo.customizations -> Customization[]; CompletionsParams.session -> channel; MessageAttachment gains its annotations variant; SessionState gains the inputNeeded aggregate. - Actions: session/diffsChanged -> session/changesetsChanged; drop session/activityChanged from the client-dispatched table (it is server- originated); drop the redundant `session: URI` field from session/activeClientSet examples (routing is by the envelope channel); changeset/disposed -> changeset/cleared. - Wire shapes: auth-required error data is an AuthRequiredErrorData object ({ resources: [...] }), not a bare array; ChangesetOperation.status gains 'disabled'; SessionSummary `diffs` -> `changes`; terminal actions route by the envelope channel (no `terminal: URI` field); the protocol version is a SemVer string (0.5.2), not a single integer; createSession drops the nonexistent `model` param; a valid ToolCallConfirmationReason ("user-action"). No wire or type changes; docs only.
connor4312
reviewed
Jul 7, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
connor4312
previously approved these changes
Jul 7, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
meganrogge
previously approved these changes
Jul 7, 2026
joshmouch
force-pushed
the
pr/docs-architecture-accuracy
branch
2 times, most recently
from
c1c5d94 to
ae8121e
Compare
Contributor
Author
|
Sorry for the branch churn here! I force-pushed a rebase by mistake and it dismissed the approval. I've restored the branch to exactly |
Member
|
No worries, though I think you brought in the .net client on this branch by mistake :) |
roblourens
previously approved these changes
Jul 7, 2026
dmitrivMS
previously approved these changes
Jul 7, 2026
joshmouch
force-pushed
the
pr/docs-architecture-accuracy
branch
from
e3aaa49 to
aa110d6
Compare
Contributor
Author
|
Good catch, thanks, and sorry! That was an errant |
anthonykim1
approved these changes
Jul 8, 2026
TylerLeonhardt
approved these changes
Jul 8, 2026
colbylwilliams
added a commit
that referenced
this pull request
Jul 8, 2026
Brings in the MCP server start/stop actions (`session/mcpServerStartRequested` / `session/mcpServerStopRequested`, #319), the optional `version` field on `PluginCustomization` (#317), the `ToolResultTerminalCompleteContent` shell exit tool-result metadata (#314), and the guide/spec docs accuracy pass (#312). Resolved conflicts: - The six CHANGELOGs — kept main's new bullets and appended the canvas bullet under the current unreleased section (matching main's per-file placement). - `clients/rust/crates/ahp/src/reducers.rs` — merged the state-import list so it keeps both `CanvasState` and main's new `McpServer*State` types (cargo fmt re-wrapped). - `docs/specification/subscriptions.md` — kept main's edits (dropped `unsubscribe` from the channel-scoped command row; reworded the resource-watch id as "receiver-assigned") and re-added the canvas rows. Regenerated all client artifacts and schemas; the canvas channel still registers its actions at spec 0.5.2 and PROTOCOL_VERSION is unchanged. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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
7 participants
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.
What
Doc-vs-
types/*.tsdrift found while verifying the guides, independent of themulti-chat (#213) channel move:
Type / field names
ModelInfo→SessionModelInfoUserMessage→MessageContentRef.mimeType→contentTypeAgentInfo.customizations→Customization[]CompletionsParams.session→channelMessageAttachmentgains its annotations variant;SessionStategains theinputNeededaggregate.Actions
session/diffsChanged→session/changesetsChangedsession/activityChangedfrom the client-dispatched table (it isserver-originated)
session: URIfield fromsession/activeClientSetexamples (routing is by the envelope channel)
changeset/disposed→changeset/clearedWire shapes
datais anAuthRequiredErrorDataobject(
{ resources: [...] }), not a bare arrayChangesetOperation.statusgains'disabled'SessionSummary.diffs→changesterminal: URIfield)0.5.2), not a single integercreateSessiondrops the nonexistentmodelparamToolCallConfirmationReason("user-action")Scope
Docs only — no wire or type changes. Each rename/shape above was re-verified
against the current type on
main(e.g.SessionModelInfointypes/channels-root/state.ts,AuthRequiredErrorDataintypes/common/errors.ts,ChangesetOperation.Disabledintypes/channels-changeset/*).10 files, +28/−36.