docs(fix): clarify that fix/fix pin only accept the JSON MCP surfaces#49
Merged
Conversation
The CLI table listed a single `<surface>` placeholder backed by all nine audited surfaces, but `<surface>` is only ever the `--canonical` argument to `fix` / `fix pin`, which reject everything except the five JSON MCP surfaces (root_mcp, cursor_mcp, vscode_mcp, codeium_mcp, windsurf_mcp). Split the docs into the audit surface set vs. the (narrower) set fix can align, so the README matches the code instead of implying `fix --canonical claude` works. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.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
1 participant
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.
Problem
The CLI reference documented a single
<surface>placeholder as "one of:root_mcp,cursor_mcp,vscode_mcp,codeium_mcp,windsurf_mcp,claude,codex,aider,instructions."But
<surface>only ever appears as the--canonicalargument tofix/fix pin, and both reject everything except the five JSON MCP surfaces —planEnabledStateFixes/planPinFixesthrow--canonical must be a JSON MCP surface in v1 …forclaude,codex,aider, andinstructions. So the docs impliedfix --canonical claudewas supported when it errors out.Fix
Docs-only. Split the wording into:
fix/fix pincan actually align (with a note on why — the line-targeted JSON editor preserves comments/indentation only for those formats, andfixerrors rather than risk a lossy TOML/other rewrite).No code change; all 118 tests pass.
🤖 Generated with Claude Code