Skip to content

Commit 0a5901f

Browse files
docs: MCP integration section in README (mcp-server-scope Phase 5) (#54)
Closes tasks 5.1–5.3 of docs/specs/mcp-server-scope/. Adds a "## MCP integration" section to the README between Architecture and Security: - One-paragraph framing (read-mostly tool surface, same data the dashboard renders, mcp is a core dep so no extra install) - Five-tool table with one-line descriptions and the JSON envelope contract - Wiring snippet — copy-paste .mcp.json for Claude Code - Cross-link to attune-ai's ops-specs-features spec as the human-side complement (per task 5.3) Marks 5.1–5.3 done in tasks.md. CHANGELOG entry under Unreleased. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent f637cf7 commit 0a5901f

3 files changed

Lines changed: 58 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
77

88
### Added
99

10+
- **MCP server — Phase 5 docs.** New "## MCP integration" section
11+
in the README covers install, the five tools at a glance, the
12+
`.mcp.json` snippet for wiring `attune-gui-mcp` into Claude Code,
13+
and a cross-link to attune-ai's complementary `ops-specs-features`
14+
spec. Completes the [mcp-server-scope](docs/specs/mcp-server-scope/)
15+
spec's Phase 5.
1016
- **MCP server — Phase 2 tools.** Five read-mostly tools wired
1117
on top of the Phase 1 scaffold, each returning a
1218
JSON-serializable envelope with `{"success": bool, ...}`:

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,55 @@ needs editor-grade interactivity — rich text editing, real-time conflict
215215
resolution, multi-file refactor previews. Inline actions, polling, and
216216
form-driven dashboards stay server-rendered.
217217

218+
## MCP integration
219+
220+
attune-gui ships an MCP server (`attune-gui-mcp`) that exposes a small,
221+
read-mostly tool surface for Claude Code and other MCP clients. Same
222+
data the dashboard renders — specs and living docs — but addressable
223+
programmatically. `mcp>=0.9.0` is a core dependency, so `pip install
224+
attune-gui` is enough to get both the dashboard and the MCP server.
225+
226+
### Tools
227+
228+
| Tool | What it returns |
229+
|---|---|
230+
| `gui_list_specs` | All feature specs across configured roots (federated). Each tagged with project, root, phase, status. |
231+
| `gui_get_spec` | All phase-file contents (`requirements.md` / `design.md` / `tasks.md`) for one spec. |
232+
| `gui_get_spec_status` | The `**Status**:` value for one phase. Default: most-advanced phase. |
233+
| `gui_list_living_docs` | Doc registry — generated docs the workspace tracks, with status (current/stale/missing) and persona. |
234+
| `gui_get_living_doc` | One living-doc's file content. Path-traversal guarded. |
235+
236+
Every tool returns a JSON envelope shaped `{"success": bool, ...}`.
237+
See [`docs/specs/mcp-server-scope/`](docs/specs/mcp-server-scope/) for
238+
the scope decisions and tool schemas.
239+
240+
### Wiring into Claude Code
241+
242+
Add to your project's `.mcp.json` (or `~/.claude/mcp.json` for global):
243+
244+
```json
245+
{
246+
"mcpServers": {
247+
"attune-gui": {
248+
"command": "attune-gui-mcp"
249+
}
250+
}
251+
}
252+
```
253+
254+
The server boots on stdio and logs to
255+
`<tmpdir>/attune-gui/attune-gui-mcp.log` so the MCP transport stays
256+
clean. Restart Claude Code after editing the config; the five tools
257+
appear under the `attune-gui` server in `/mcp`.
258+
259+
### Related work
260+
261+
attune-ai's [ops-specs-features](https://github.com/Smart-AI-Memory/attune-ai/blob/main/docs/specs/ops-specs-features/decisions.md)
262+
spec is the complement to this one: that work brings attune-gui's
263+
spec views into the attune-ai ops dashboard for humans; this MCP
264+
server exposes the same views to agents. Both serve the spec-driven
265+
workflow, just for different clients.
266+
218267
## Security notes
219268

220269
This is a **single-user, local-only** app. Not designed for multi-user

docs/specs/mcp-server-scope/tasks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ Each tool:
5252

5353
## Phase 5 — Docs
5454

55-
- [ ] **5.1** README section: "MCP integration" — how to
55+
- [x] **5.1** README section: "MCP integration" — how to
5656
configure Claude Code to use the server
57-
- [ ] **5.2** Example `.mcp.json` snippet showing
57+
- [x] **5.2** Example `.mcp.json` snippet showing
5858
`attune-gui-mcp` registered
59-
- [ ] **5.3** Cross-link with attune-ai's
59+
- [x] **5.3** Cross-link with attune-ai's
6060
ops-specs-features spec (the two complement each other)
6161

6262
## Out of scope

0 commit comments

Comments
 (0)