fix(mcp): clarify install help forwarded options#2018
Conversation
Align docs/reference/cli/mcp.md terminology with the CLI help text changed in the parent commit. The CLI now says 'Forwarded install options'; the reference page still said 'Common forwarded options'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
APM Review Panel:
|
| Persona | B | R | N | Takeaway |
|---|---|---|---|---|
| Python Architect | 0 | 0 | 1 | Clean epilog-to-help migration uses Click \b escape correctly; no architectural concerns, net UX improvement. |
| CLI Logging Expert | 0 | 0 | 0 | Clean net-positive: correct Click \b usage, better placement (help vs epilog), and more accurate label. No regressions. |
| DevX UX Expert | 0 | 0 | 1 | Moving forwarded-options block from epilog to description is a clear UX win; eliminates native-vs-forwarded confusion. |
| Supply Chain Security Expert | 0 | 0 | 0 | Pure static help-text rewording; no runtime, dependency, auth, or path changes. No supply-chain surface affected. |
| OSS Growth Hacker | 0 | 0 | 1 | Small net win: 'Forwarded install options' teaches the command-composition mental model and the cross-ref drives discoverability. |
| Doc Writer | 0 | 0 | 3 | Label change accurate and clearer; terminology drift in docs folded (commit 11de488 syncs reference page). |
| Test Coverage Expert | 0 | 0 | 0 | Help-text-only change ships with adequate regression tests; mutation-break analysis passes; no critical-promise surface touched. |
B = blocking-severity findings, R = recommended, N = nits.
Counts are signal strength, not gates. The maintainer ships.
Top follow-ups
- [DevX UX Expert] Consider whether 'Forwarded' label needs further clarification for day-one users -- minor jargon concern; parenthetical compensates today but worth revisiting if onboarding friction surfaces in issues.
Shepherd actions taken
- Folded: docs terminology sync --
docs/src/content/docs/reference/cli/mcp.mdupdated from "Common forwarded options" to "Forwarded install options" (commit 11de488, pushed to author fork). - Deferred: test-assertion deduplication across identical test files (pre-existing condition; would require broader refactor of two 2040-line files; scope-crossing).
Recommendation
All angles satisfy the maintainer's net-win reservation. Correctness, UX, security, maintainability, and docs are each neutral-to-positive with no regressions. The single terminology-drift nit is now resolved. Ship now.
Full per-persona findings
Python Architect
- [nit] Identical test assertions duplicated across two integration test files at
tests/integration/test_commands_mcp_flow.py
These two files are pre-existing identical files. If the help text changes again, both must be updated. A shared helper would reduce maintenance surface. Pre-existing condition; not introduced by this PR.
Suggested: Extract_assert_forwarded_options_in_description(output)into a shared test utilities module.
CLI Logging Expert
No findings.
DevX UX Expert
- [nit] 'Forwarded' is slightly jargon-y for first-encounter users at
src/apm_cli/commands/mcp.py:95
A brand-new user may not immediately parse 'Forwarded install options' as meaning 'these flags get passed through to apm install'. The parenthetical cross-reference compensates well, so this is cosmetic at most.
Supply Chain Security Expert
No findings.
OSS Growth Hacker
- [nit] Consider whether 'Forwarded' is the friendliest word for a day-one user at
src/apm_cli/commands/mcp.py:95
Parenthetical compensates today. No action required; flagged for awareness.
Auth Expert -- inactive
PR touches only src/apm_cli/commands/mcp.py (help text) and test files; no auth, token, or credential resolution surfaces affected.
Doc Writer
- [nit] Terminology drift between CLI help and reference docs -- FOLDED in this shepherd run
docs/reference/cli/mcp.md still said 'Common forwarded options' while CLI now says 'Forwarded install options'. Fixed in commit 11de488. - [nit] Cross-reference is accurate and improved -- docs/reference/cli/install.md confirms all options listed are documented.
- [nit] Epilog-to-help structural move improves discoverability; no additional doc change needed beyond the label sync.
Test Coverage Expert
No findings.
Performance Expert -- inactive
PR touches only src/apm_cli/commands/mcp.py (help text strings) and test files; no cache, deps, install pipeline, or transport paths affected.
This panel is advisory. It does not block merge. Re-apply the
panel-review label after addressing feedback to re-run.
danielmeppiel
left a comment
There was a problem hiding this comment.
Approving as maintainer: triaged via apm-issue-autopilot, driven to green CI, advisory review panels clean. Batch-merge authorized.
Summary
Part of #2006.
apm install --mcpoption summary into theapm mcp installcommand description instead of rendering it after theOptions:sectionOptions:sectionValidation
.venv\Scripts\python.exe -m pytest tests\integration\test_commands_mcp_phase3c.py::TestMcpGroupHelp::test_mcp_install_help tests\integration\test_commands_mcp_flow.py::TestMcpGroupHelp::test_mcp_install_help -q.venv\Scripts\python.exe -m pytest tests\integration\test_commands_mcp_phase3c.py tests\integration\test_commands_mcp_flow.py -q.venv\Scripts\python.exe -m pytest tests\unit\test_cli_consistency.py -q.venv\Scripts\python.exe -m ruff check src\apm_cli\commands\mcp.py tests\integration\test_commands_mcp_phase3c.py tests\integration\test_commands_mcp_flow.py.venv\Scripts\python.exe -m ruff format --check src\apm_cli\commands\mcp.py tests\integration\test_commands_mcp_phase3c.py tests\integration\test_commands_mcp_flow.py.venv\Scripts\apm.exe mcp install --helpgit diff --check origin/main...HEAD