From 1b8edb7ebac4d32ebb9a59cfeb567ceb033f4221 Mon Sep 17 00:00:00 2001 From: robbond Date: Fri, 12 Jun 2026 13:26:15 +0100 Subject: [PATCH] docs: refresh README for MVP completion --- .gitignore | 1 + AGENT_HANDOFF.md | 10 +++++++++- PROJECT_STATE.md | 12 ++++++++++-- TASKS.md | 20 +++++++++++++++++++- 4 files changed, 39 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 0716831..5a1c4b0 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ coverage/ .DS_Store .vscode/ .idea/ +.claude/ diff --git a/AGENT_HANDOFF.md b/AGENT_HANDOFF.md index 8b2a668..0f083a8 100644 --- a/AGENT_HANDOFF.md +++ b/AGENT_HANDOFF.md @@ -116,9 +116,17 @@ MCP tool error formatting normalized in `src/server.js`. All 5 tool registration Smoke tests: npm test 523 passed ✅ · tools/list 5 tools ✅ · ask_chatgpt single prefix ✅ · review_plan single prefix ✅ +### Task 5.5 - Claude Code MCP configuration and local end-to-end setup ✅ + +Project-local Claude Code discovery configured: +- `.claude/` added to `.gitignore` — no machine-specific paths in repo +- README.md updated with Setup, MCP Tools, and Running sections +- MCP config uses `"command": "npm"`, `"args": ["start"]` — platform-independent +- All 5 tools documented: `ask_chatgpt`, `review_plan`, `review_code`, `debug_issue`, `architecture_review` + ## Next Pending -### Task 5.5 - Claude Code MCP configuration and local end-to-end setup +N/A — all planned tasks complete. ## General Rules diff --git a/PROJECT_STATE.md b/PROJECT_STATE.md index 768bba3..17aecea 100644 --- a/PROJECT_STATE.md +++ b/PROJECT_STATE.md @@ -7,7 +7,7 @@ ChatGPT MCP Server ## Status Planning complete. -Phase 0 complete. Phase 1 complete. Phase 2 complete. Phase 3 complete. Task 4.1 complete. Task 4.2 complete. Task 4.3 complete. Task 4.4 complete. Task 4.5 complete. Phase 4 complete. Task 5.1 complete. Task 5.2 complete. Task 5.3 complete. Task 5.4 complete. +Phase 0 complete. Phase 1 complete. Phase 2 complete. Phase 3 complete. Task 4.1 complete. Task 4.2 complete. Task 4.3 complete. Task 4.4 complete. Task 4.5 complete. Phase 4 complete. Task 5.1 complete. Task 5.2 complete. Task 5.3 complete. Task 5.4 complete. Task 5.5 complete. ## Current Phase @@ -75,6 +75,14 @@ Phase 5 - MCP Server and Tool Registration MCP tool error formatting normalized in `src/server.js`. All 5 tools now produce a single "Error:" prefix with no duplicates. +- Task 5.5 — Claude Code MCP configuration and local end-to-end setup ✅ + +Project-local Claude Code discovery configured: +- `.claude/` added to `.gitignore` (no machine-specific paths committed) +- README.md updated with Setup, MCP Tools, and Running sections +- MCP config snippet uses `"command": "npm"`, `"args": ["start"]` — no absolute paths +- All 5 tools documented in README + ## Phase 3 Completion Summary Phase 3 — Tool Inputs and Prompts — is now complete. @@ -126,4 +134,4 @@ All five tool handlers are implemented and tested: ## Next Pending -### Task 5.5 - Claude Code MCP configuration and local end-to-end setup +N/A — all planned tasks complete. diff --git a/TASKS.md b/TASKS.md index 56cdfc5..17f8ede 100644 --- a/TASKS.md +++ b/TASKS.md @@ -565,4 +565,22 @@ Smoke tests: Status: ✅ Complete -### Task 5.5 - Claude Code MCP configuration and local end-to-end setup (NEXT) +### Task 5.5 - Claude Code MCP configuration and local end-to-end setup ✅ + +Configure project-local Claude Code discovery via `.claude/settings.local.json` and document local setup steps in README. + +**Requirements:** +- Add `.claude/` to `.gitignore` so machine-specific MCP config is not committed. +- Document `npm install`, `export OPENAI_API_KEY=...`, `npm test`, `npm start` in README. +- Provide Claude Code MCP config snippet using `"command": "npm"`, `"args": ["start"]` (no absolute paths). +- List all 5 available MCP tools with descriptions in README. + +**Changes made:** +- Added `.claude/` to `.gitignore` ✅ +- Updated `README.md` with Setup, MCP Tools, and Running sections ✅ + +**What was NOT done:** +- No `.claude/settings.local.json` committed — machine-specific config remains local only ✅ +- No secrets or absolute paths in any tracked file ✅ + +Status: ✅ Complete