|
| 1 | +# PRD — FU-REBUILD-P10-T1-4 Add Web UI Argument Examples for Client Configs |
| 2 | + |
| 3 | +## Objective Summary |
| 4 | +The goal of this follow-up task is to close the documentation gap for enabling the optional Web UI dashboard when configuring MCP clients. Existing docs and config examples show the base wrapper command but do not consistently include argument examples for `--web-ui` and `--web-ui-port`. This creates avoidable setup friction for users who want audit logs, live metrics, and request inspection from day one. |
| 5 | + |
| 6 | +This task updates client-facing configuration examples for Zed, Cursor, Claude Code, and Codex CLI so each client has an explicit “with Web UI” variant. Examples must be copy/paste-ready, consistent with actual wrapper CLI options, and aligned with current configuration formats used in this repository (`json` snippets for Zed/Cursor and command-line examples for Claude/Codex). |
| 7 | + |
| 8 | +The deliverable is documentation/config updates only; runtime behavior is already implemented and out of scope for code changes. |
| 9 | + |
| 10 | +## Success Criteria and Acceptance Tests |
| 11 | +- Each target client has a concrete Web UI-enabled example that includes both `--web-ui` and `--web-ui-port`. |
| 12 | +- No existing non-Web-UI examples are removed; Web UI usage is additive and clearly labeled optional. |
| 13 | +- Examples are syntactically valid for each client’s expected format. |
| 14 | +- README and docs remain internally consistent (same flags, same option spelling, no contradictory guidance). |
| 15 | + |
| 16 | +Acceptance tests: |
| 17 | +1. Search-based verification confirms all four clients expose Web UI example usage. |
| 18 | +2. Manual snippet review confirms command argument placement is correct per client format. |
| 19 | +3. `pytest`, `ruff check src/`, `mypy src/`, and `pytest --cov=src/mcpbridge_wrapper --cov-report=term-missing` all pass. |
| 20 | + |
| 21 | +## Test-First Plan |
| 22 | +1. Add/adjust docs assertions through deterministic checks: |
| 23 | + - `rg` checks for each client and each flag (`--web-ui`, `--web-ui-port`). |
| 24 | +2. Make minimal doc/config edits needed to satisfy checks. |
| 25 | +3. Re-run search checks and standard quality gates. |
| 26 | + |
| 27 | +## Hierarchical TODO Plan |
| 28 | +### Phase A — Baseline and Scope Validation |
| 29 | +- **Inputs:** `README.md`, `docs/*setup.md`, `config/*` examples. |
| 30 | +- **Outputs:** Gap list showing where Web UI argument examples are missing. |
| 31 | +- **Verification:** `rg` output demonstrates pre-change absence or incompleteness. |
| 32 | + |
| 33 | +### Phase B — Implement Documentation and Config Updates |
| 34 | +- **Inputs:** Gap list from Phase A. |
| 35 | +- **Outputs:** Updated snippets for Zed, Cursor, Claude Code, and Codex CLI showing Web UI variants. |
| 36 | +- **Verification:** Render/read each snippet for correctness and consistency of flag usage. |
| 37 | + |
| 38 | +### Phase C — Validate and Record Evidence |
| 39 | +- **Inputs:** Updated files. |
| 40 | +- **Outputs:** Passing quality gates and a validation report at `SPECS/INPROGRESS/FU-REBUILD-P10-T1-4_Validation_Report.md`. |
| 41 | +- **Verification:** Command outputs captured in report with PASS/PARTIAL/FAIL verdict. |
| 42 | + |
| 43 | +## Decision Points and Constraints |
| 44 | +- Keep defaults unchanged: Web UI remains optional and opt-in. |
| 45 | +- Use a single illustrative port (8080) unless an existing file already uses another standard. |
| 46 | +- Avoid introducing client-specific behavior claims not backed by existing project behavior. |
| 47 | + |
| 48 | +## Notes |
| 49 | +After implementation, ensure these references remain aligned: |
| 50 | +- `README.md` client sections |
| 51 | +- `docs/cursor-setup.md`, `docs/claude-setup.md`, `docs/codex-setup.md` |
| 52 | +- `config/cursor-mcp.json`, `config/claude-code.txt`, `config/codex-cli.txt`, `config/zed-agent.json` |
| 53 | + |
| 54 | +--- |
| 55 | +**Archived:** 2026-02-11 |
| 56 | +**Verdict:** PASS |
0 commit comments