Skip to content

Commit 8abb25e

Browse files
authored
Merge pull request #13 from SoundBlaster/feature/FU-REBUILD-P10-T1-4-web-ui-args-examples
P10-T1-4 Add web UI args examples
2 parents a321068 + 8aafe46 commit 8abb25e

15 files changed

Lines changed: 373 additions & 10 deletions

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,25 @@ Edit `~/.cursor/mcp.json`:
148148
}
149149
```
150150

151+
**Using uvx with Web UI (Optional):**
152+
```json
153+
{
154+
"mcpServers": {
155+
"xcode-tools": {
156+
"command": "uvx",
157+
"args": [
158+
"--from",
159+
"mcpbridge-wrapper",
160+
"mcpbridge-wrapper",
161+
"--web-ui",
162+
"--web-ui-port",
163+
"8080"
164+
]
165+
}
166+
}
167+
}
168+
```
169+
151170
**Using manual installation:**
152171

153172
```json
@@ -161,6 +180,18 @@ Edit `~/.cursor/mcp.json`:
161180
}
162181
```
163182

183+
**Using manual installation with Web UI (Optional):**
184+
```json
185+
{
186+
"mcpServers": {
187+
"xcode-tools": {
188+
"command": "/Users/YOUR_USERNAME/bin/xcodemcpwrapper",
189+
"args": ["--web-ui", "--web-ui-port", "8080"]
190+
}
191+
}
192+
}
193+
```
194+
164195
#### Claude Code
165196

166197
**Using uvx (Recommended):**
@@ -169,12 +200,22 @@ Edit `~/.cursor/mcp.json`:
169200
claude mcp add --transport stdio xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
170201
```
171202

203+
**Using uvx with Web UI (Optional):**
204+
```bash
205+
claude mcp add --transport stdio xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper --web-ui --web-ui-port 8080
206+
```
207+
172208
**Using manual installation:**
173209

174210
```bash
175211
claude mcp add --transport stdio xcode -- ~/bin/xcodemcpwrapper
176212
```
177213

214+
**Using manual installation with Web UI (Optional):**
215+
```bash
216+
claude mcp add --transport stdio xcode -- ~/bin/xcodemcpwrapper --web-ui --web-ui-port 8080
217+
```
218+
178219
#### Codex CLI
179220

180221
**Using uvx (Recommended):**
@@ -183,12 +224,22 @@ claude mcp add --transport stdio xcode -- ~/bin/xcodemcpwrapper
183224
codex mcp add xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
184225
```
185226

227+
**Using uvx with Web UI (Optional):**
228+
```bash
229+
codex mcp add xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper --web-ui --web-ui-port 8080
230+
```
231+
186232
**Using manual installation:**
187233

188234
```bash
189235
codex mcp add xcode -- ~/bin/xcodemcpwrapper
190236
```
191237

238+
**Using manual installation with Web UI (Optional):**
239+
```bash
240+
codex mcp add xcode -- ~/bin/xcodemcpwrapper --web-ui --web-ui-port 8080
241+
```
242+
192243
#### Zed Agent
193244

194245
**Using uvx (Recommended):**
@@ -205,6 +256,24 @@ Edit `~/.zed/settings.json`:
205256
}
206257
```
207258

259+
**Using uvx with Web UI (Optional):**
260+
```json
261+
{
262+
"xcode-tools": {
263+
"command": "uvx",
264+
"args": [
265+
"--from",
266+
"mcpbridge-wrapper",
267+
"mcpbridge-wrapper",
268+
"--web-ui",
269+
"--web-ui-port",
270+
"8080"
271+
],
272+
"env": {}
273+
}
274+
}
275+
```
276+
208277
**Using manual installation:**
209278

210279
```json
@@ -217,6 +286,17 @@ Edit `~/.zed/settings.json`:
217286
}
218287
```
219288

289+
**Using manual installation with Web UI (Optional):**
290+
```json
291+
{
292+
"xcode-tools": {
293+
"command": "/Users/YOUR_USERNAME/bin/xcodemcpwrapper",
294+
"args": ["--web-ui", "--web-ui-port", "8080"],
295+
"env": {}
296+
}
297+
}
298+
```
299+
220300
#### Kimi CLI
221301

222302
**Using uvx (Recommended):**
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# FOLLOW-UP — FU-REBUILD-P10-T1-4 Web UI Docs Coverage
2+
3+
## Source Review
4+
- `SPECS/INPROGRESS/REVIEW_FU-REBUILD-P10-T1-4_Web_UI_Docs_Coverage.md`
5+
6+
## Result
7+
- No actionable issues were identified in review.
8+
- No new backlog tasks added to `SPECS/Workplan.md`.
9+
10+
## Decision
11+
- FOLLOW-UP step is complete with no additional tasks.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Validation Report — FU-REBUILD-P10-T1-4
2+
3+
**Task:** Add Web UI Argument Examples for Client Configs
4+
**Date:** 2026-02-11
5+
**Verdict:** PASS
6+
7+
## Scope
8+
Validated documentation and configuration updates adding optional Web UI examples for:
9+
- Zed Agent
10+
- Cursor
11+
- Claude Code
12+
- Codex CLI
13+
14+
## Change Verification
15+
16+
### 1. Web UI argument coverage in target files
17+
Command:
18+
```bash
19+
rg -n -e "--web-ui" -e "--web-ui-port" README.md docs/cursor-setup.md docs/claude-setup.md docs/codex-setup.md config/cursor-mcp.json config/zed-agent.json config/claude-code.txt config/codex-cli.txt
20+
```
21+
22+
Result: PASS
23+
- Matches found across all targeted docs/config files for both `--web-ui` and `--web-ui-port`.
24+
25+
## Required Quality Gates
26+
27+
### 2. Test suite
28+
Command:
29+
```bash
30+
pytest
31+
```
32+
Result: PASS
33+
- `202 passed, 5 skipped`
34+
35+
### 3. Linting
36+
Command:
37+
```bash
38+
ruff check src/
39+
```
40+
Result: PASS
41+
- `All checks passed!`
42+
43+
### 4. Type checking
44+
Command:
45+
```bash
46+
mypy src/
47+
```
48+
Result: PASS
49+
- `Success: no issues found in 5 source files`
50+
51+
### 5. Coverage
52+
Command:
53+
```bash
54+
pytest --cov=src/mcpbridge_wrapper --cov-report=term-missing
55+
```
56+
Result: PASS
57+
- `TOTAL 95.0%`
58+
- Requirement `>=90%` satisfied.
59+
60+
## Acceptance Criteria Mapping
61+
- Web UI examples include both flags for all required clients: PASS
62+
- Existing base examples preserved as optional/additive variants: PASS
63+
- Examples syntactically match each client format (JSON vs CLI): PASS
64+
- Cross-doc consistency of flags and port example (`8080`): PASS
65+
66+
## Notes
67+
- No source code behavior changes were required; this task is documentation/configuration only.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## REVIEW REPORT — FU-REBUILD-P10-T1-4 Web UI Docs Coverage
2+
3+
**Scope:** origin/main..HEAD
4+
**Files:** 13
5+
6+
### Summary Verdict
7+
- [x] Approve
8+
- [ ] Approve with comments
9+
- [ ] Request changes
10+
- [ ] Block
11+
12+
### Critical Issues
13+
- None.
14+
15+
### Secondary Issues
16+
- None.
17+
18+
### Architectural Notes
19+
- Documentation and template changes are consistent with current CLI behavior and keep Web UI as an optional additive path. Existing non-Web-UI examples remain intact.
20+
21+
### Tests
22+
- `pytest`: PASS (`202 passed, 5 skipped`)
23+
- `ruff check src/`: PASS
24+
- `mypy src/`: PASS
25+
- `pytest --cov=src/mcpbridge_wrapper --cov-report=term-missing`: PASS (95.04%, >=90%)
26+
- Residual risk: this is a docs/config task, so no runtime regressions are expected; command examples rely on CLI flag stability.
27+
28+
### Next Steps
29+
- No actionable follow-up tasks required.
30+
- Proceed to archive this review artifact under `_Historical` per FLOW `ARCHIVE-REVIEW` step.

SPECS/ARCHIVE/INDEX.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@
6969
| FU-REBUILD-P10-T1-1 | [FU-REBUILD-P10-T1-1_Align_WebSocket_Auth_Flow/](FU-REBUILD-P10-T1-1_Align_WebSocket_Auth_Flow/) | 2026-02-10 | PASS |
7070
| FU-REBUILD-P10-T1-2 | [FU-REBUILD-P10-T1-2_Validate_WebUI_Port_Input/](FU-REBUILD-P10-T1-2_Validate_WebUI_Port_Input/) | 2026-02-10 | PASS |
7171
| FU-REBUILD-P10-T1-3 | [FU-REBUILD-P10-T1-3_Reconcile_WebUI_Env_Docs/](FU-REBUILD-P10-T1-3_Reconcile_WebUI_Env_Docs/) | 2026-02-10 | PASS |
72+
| FU-REBUILD-P10-T1-4 | [FU-REBUILD-P10-T1-4_Add_Web_UI_Argument_Examples_for_Client_Configs/](FU-REBUILD-P10-T1-4_Add_Web_UI_Argument_Examples_for_Client_Configs/) | 2026-02-11 | PASS |
7273

7374
## Historical Artifacts
7475

@@ -99,6 +100,8 @@
99100
| [P5-T1_Create_Unit_Test_Framework_PRD.md](_Historical/P5-T1_Create_Unit_Test_Framework_PRD.md) | Historical PRD source file for P5-T1 |
100101
| [P5-T1_validation_report.md](_Historical/P5-T1_validation_report.md) | Historical validation report source file for P5-T1 |
101102
| [Web_UI_Debugging_Summary.md](_Historical/Web_UI_Debugging_Summary.md) | Web UI debugging summary moved from INPROGRESS |
103+
| [REVIEW_FU-REBUILD-P10-T1-4_Web_UI_Docs_Coverage.md](FU-REBUILD-P10-T1-4_Add_Web_UI_Argument_Examples_for_Client_Configs/REVIEW_FU-REBUILD-P10-T1-4_Web_UI_Docs_Coverage.md) | Review report for FU-REBUILD-P10-T1-4 |
104+
| [FOLLOWUP_FU-REBUILD-P10-T1-4_Web_UI_Docs_Coverage.md](FU-REBUILD-P10-T1-4_Add_Web_UI_Argument_Examples_for_Client_Configs/FOLLOWUP_FU-REBUILD-P10-T1-4_Web_UI_Docs_Coverage.md) | Follow-up report for FU-REBUILD-P10-T1-4 |
102105

103106
## Archive Log
104107

@@ -154,3 +157,5 @@
154157
| 2026-02-11 | P5-T1 | Archived historical artifacts (PRD and validation source files) |
155158
| 2026-02-11 | P4-T9 | Archived Handle_Large_JSON_Responses (PASS) |
156159
| 2026-02-11 | HISTORICAL | Archived Web_UI_Debugging_Summary.md to _Historical |
160+
| 2026-02-11 | FU-REBUILD-P10-T1-4 | Archived Add_Web_UI_Argument_Examples_for_Client_Configs (PASS) |
161+
| 2026-02-11 | FU-REBUILD-P10-T1-4 | Archived REVIEW_FU-REBUILD-P10-T1-4_Web_UI_Docs_Coverage report |

SPECS/INPROGRESS/next.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
# Next Task: FU-REBUILD-P10-T1-4 — Add Web UI Argument Examples for Client Configs
1+
# No Active Task
22

3-
**Priority:** P2
4-
**Phase:** Rebuild Follow-up Backlog (Phase 10)
5-
**Effort:** 1-2 hours
6-
**Dependencies:** FU-REBUILD-P10-T1-1, FU-REBUILD-P10-T1-2, FU-REBUILD-P10-T1-3
7-
**Status:** Selected
3+
The previously selected task has been archived.
84

9-
## Description
5+
## Recently Archived
106

11-
Add Web UI argument examples for client configs (Zed, Cursor, Claude Code, Codex CLI), including `--web-ui` and `--web-ui-port` usage.
7+
- 2026-02-11 — FU-REBUILD-P10-T1-4: Add Web UI Argument Examples for Client Configs (PASS)
128

13-
## Next Step
9+
## Suggested Next Tasks
1410

15-
Run the PLAN command to generate the implementation-ready PRD.
11+
- Run SELECT to identify the next available task from `SPECS/Workplan.md`.

SPECS/Workplan.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1163,6 +1163,7 @@ Completion criteria:
11631163
Post-Completion Validation:
11641164
- [x] P8-T3 validated: Installation with new path `xcodemcpwrapper` tested successfully
11651165
- [x] Client compatibility verified: Zed Agent ✅, Cursor ✅, Claude Code ✅, Codex CLI ✅
1166+
- [x] FU-REBUILD-P10-T1-4 completed: Web UI argument examples documented for Zed, Cursor, Claude Code, and Codex CLI (2026-02-11)
11661167
- [ ] Known issue documented: Kimi CLI v1.9.0 has MCP connection issues (BUG-T1)
11671168

11681169
Phase 10: Web UI Dashboard

config/claude-code.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
#
77
# claude mcp add --transport stdio xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
88
#
9+
# OPTION 1B: Using uvx with Web UI (Optional)
10+
# -------------------------------------------
11+
# Enable the Web UI dashboard on port 8080:
12+
#
13+
# claude mcp add --transport stdio xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper --web-ui --web-ui-port 8080
14+
#
915
# To install uv (which includes uvx):
1016
# curl -LsSf https://astral.sh/uv/install.sh | sh
1117
# or: brew install uv
@@ -17,6 +23,12 @@
1723
#
1824
# claude mcp add --transport stdio xcode -- /Users/USERNAME/bin/xcodemcpwrapper
1925
#
26+
# OPTION 2B: Manual Installation with Web UI (Optional)
27+
# -----------------------------------------------------
28+
# Enable the Web UI dashboard on port 8080:
29+
#
30+
# claude mcp add --transport stdio xcode -- /Users/USERNAME/bin/xcodemcpwrapper --web-ui --web-ui-port 8080
31+
#
2032
#
2133
# Verification:
2234
# claude mcp list

0 commit comments

Comments
 (0)