Skip to content

docs(protocol): show the required plan object in the v2 migration checklist - #2763

Merged
benbrandt merged 2 commits into
agentclientprotocol:mainfrom
PerryLink:docs/v2-migration-plan-object-20261106
Nov 6, 2026
Merged

benbrandt merged 2 commits into
agentclientprotocol:mainfrom
PerryLink:docs/v2-migration-plan-object-20261106

Conversation

@PerryLink

Copy link
Copy Markdown
Contributor

The v2 migration checklist tells readers to send plan_update with
{ "type": "items", "planId": ..., "entries": [...] }, but $defs/PlanUpdate
requires a plan object (required: ["plan"]). The same guide's Plans section
and docs/protocol/v2/agent-plan.mdx already show the plan wrapper, so the
checklist literal is the odd one out.

Before: the literal fails schema validation with 'plan' is a required property.
After: { "plan": { ... } } validates against $defs/PlanUpdate.

Docs-only change; prettier --check passes. No schema or Rust changes.

…cklist

Wrap the checklist's plan_update literal in the required plan object.
@PerryLink
PerryLink requested a review from a team as a code owner November 6, 2026 04:35
@mintlify

mintlify Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit f2d835c.

Approve preview

@benbrandt

Copy link
Copy Markdown
Member

thanks!

@benbrandt
benbrandt enabled auto-merge (squash) November 6, 2026 09:49
@benbrandt
benbrandt merged commit 4d11f2d into agentclientprotocol:main Nov 6, 2026
6 checks passed
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.

2 participants