|
| 1 | +--- |
| 2 | +name: xcodebuildmcp-docs-command-review |
| 3 | +description: Use when reviewing XcodeBuildMCP changelog CLI command references for invalid current guidance while allowing historical migration examples. |
| 4 | +allowed-tools: Read Grep Glob |
| 5 | +--- |
| 6 | + |
| 7 | +# XcodeBuildMCP Docs Command Review |
| 8 | + |
| 9 | +Review changed changelog entries for CLI command references that would mislead users or agents. |
| 10 | + |
| 11 | +## What to inspect |
| 12 | + |
| 13 | +- `CHANGELOG.md` |
| 14 | +- `manifests/tools/*.yaml` and `manifests/workflows/*.yaml` when you need to verify current CLI workflow/tool names |
| 15 | +- `src/cli/**` only when command wiring is unclear from manifests |
| 16 | + |
| 17 | +## Issue criteria |
| 18 | + |
| 19 | +Report a finding only when a command reference is presented as current guidance and appears invalid for the current CLI surface. |
| 20 | + |
| 21 | +### High severity |
| 22 | + |
| 23 | +- A changelog bullet, example, or migration instruction tells users to run a removed or invalid `xcodebuildmcp` command as the current path. |
| 24 | +- A Breaking change mentions a removed command but does not give a valid replacement. |
| 25 | +- A command reference uses the wrong workflow/tool pairing in a way a user or agent would likely copy. |
| 26 | + |
| 27 | +### Medium severity |
| 28 | + |
| 29 | +- A command reference is ambiguous enough that users may not know whether it is historical or current. |
| 30 | +- A migration example gives the right replacement but does not clearly label the old command as "Before", "old", "removed", or equivalent. |
| 31 | + |
| 32 | +## Explicitly allowed |
| 33 | + |
| 34 | +Do not report removed commands when they are clearly historical context, especially in: |
| 35 | + |
| 36 | +- Breaking-change migration sections |
| 37 | +- "Before" examples paired with valid "After" examples |
| 38 | +- Already-released changelog sections describing past behavior |
| 39 | + |
| 40 | +Example that should not be reported: |
| 41 | + |
| 42 | +```markdown |
| 43 | +Before: |
| 44 | +xcodebuildmcp logging start-sim-log-cap |
| 45 | + |
| 46 | +After: |
| 47 | +xcodebuildmcp simulator build-and-run |
| 48 | +``` |
| 49 | + |
| 50 | +## Output |
| 51 | + |
| 52 | +For each finding, include: |
| 53 | + |
| 54 | +- Severity |
| 55 | +- File and line |
| 56 | +- The command reference |
| 57 | +- Why it reads as current guidance |
| 58 | +- Suggested replacement wording or command |
| 59 | + |
| 60 | +If all command references are historical or valid, report no findings. |
0 commit comments