@codeatlas/mcp 1.0.2 → 1.2.0

package/README.md

@@ -113,9 +113,112 @@ After registering, reload your client and the 25 tools appear alongside its buil
 
 ## Self-init: no VS Code required
 
-The MCP server bootstraps the snapshot itself when launched against a workspace that has no `.codeatlas/state.db` yet — scans the workspace, classifies it as a codebase (or returns `status: 'not_a_codebase'` for docs-only / empty dirs), runs the full indexing pipeline, and starts a file watcher to keep state current.
+The first time you point it at a workspace, the MCP server indexes the code and starts watching for changes. The AI gets working answers within seconds.
 
-**You can register the MCP server against a brand-new repo and the LLM gets working answers within seconds — no VS Code launch required.**
+Both this server and the VS Code extension can run on the same repo at the same time — they keep their own state, so they don't conflict. Add `.codeatlas-sa/` to `.gitignore` (the index lives there).
+
+---
+
+## Browser diagrams (`--browser`)
+
+Add `--browser` to view the architecture in a browser tab alongside the AI conversation:
+
+```bash
+npx @codeatlas/mcp /path/to/repo --browser
+```
+
+A tab opens at `http://localhost:7742` showing six linked diagram layers: system design, feature clusters, API list, sequences, file dependencies, and function flow. File edits propagate to the browser in real time. Click any node to open the file in your editor.
+
+| Flag | Effect |
+|------|--------|
+| `--browser` | Start the diagram view alongside the AI server |
+| `--port <N>` | Use a specific port (default 7742) |
+| `--no-open` | Don't auto-open the browser; just print the URL |
+
+Set `CODEATLAS_EDITOR=<cmd>` to pick the editor (defaults to `$EDITOR`, then `code`, `cursor`, `subl`, `nvim`, `vim`).
+
+### Connect an LLM
+
+AI Review and natural-language search use any OpenAI-compatible provider. Pick one:
+
+| Provider | Env var | `provider` setting |
+|----------|---------|--------------------|
+| OpenRouter (default) | `OPENROUTER_API_KEY` | `openrouter` |
+| OpenAI | `OPENAI_API_KEY` | `openai` |
+| Anthropic | `ANTHROPIC_API_KEY` | `anthropic` |
+| Ollama (local — no key) | — | `ollama` |
+| Custom endpoint | `LLM_API_KEY` (optional) | `custom` |
+
+Change provider + model from the browser (LLM settings panel) or write to `<workspace>/.codeatlas-sa/config.json`:
+```json
+{
+  "codeatlas.llmProvider": "anthropic",
+  "codeatlas.llmModel": "claude-3-5-sonnet-latest"
+}
+```
+
+### Compare commits, branches, and pull requests
+
+From the diagram view in your browser:
+
+- **Compare Commits** — pick base + head from a list of recent commits.
+- **Compare Branch** — pick a branch; the diff shows what that branch added relative to your current `HEAD`.
+- **Compare PR** — pick a pull request from the connected GitHub repo. Public repos work without a token (60 requests/hour limit). For private repos or higher rate limits, set `GITHUB_TOKEN` (or `GH_TOKEN`) with at least `repo` scope.
+
+### Pairing with your AI assistant
+
+The AI doesn't open the browser — you do. Register the server with `--browser` and the AI can cite URLs you click to jump straight to a specific diagram.
+
+**Claude Code:**
+```bash
+claude mcp add codeatlas -- npx -y @codeatlas/mcp $(pwd) --browser
+```
+
+**Cursor / VS Code / Codex / Gemini** — add `--browser` to the args:
+```json
+{
+  "mcpServers": {
+    "codeatlas": {
+      "command": "npx",
+      "args": ["-y", "@codeatlas/mcp", "/absolute/path/to/repo", "--browser"]
+    }
+  }
+}
+```
+
+The AI can link directly to any layer:
+
+| URL | View |
+|------|------|
+| `http://localhost:7742/` | System design |
+| `http://localhost:7742/#/features/service:main` | Feature clusters |
+| `http://localhost:7742/#/apis/cluster:auth` | APIs in a cluster |
+| `http://localhost:7742/#/sequence/<file>:<handler>` | Sequence for a route |
+| `http://localhost:7742/#/file/<path>` | File diagram |
+| `http://localhost:7742/#/flow/<path>/<fn>` | Function flow |
+
+### If port 7742 is already in use
+
+The server tries 7742 first and walks up (7743, 7744, …) up to four times if those are busy. The actual port appears in the startup log:
+
+```
+CodeAtlas browser ready: http://localhost:7743
+```
+
+To pick a specific port, pass `--port`:
+
+```bash
+npx @codeatlas/mcp /path/to/repo --browser --port 8080
+```
+
+### Restarting the server
+
+The standalone is a single process. To restart:
+
+- **Launched in a terminal:** press `Ctrl+C`, then re-run the command.
+- **Launched by an AI client** (Claude Code, Cursor, etc.): use the client's "reload MCP servers" action, or quit and reopen the client.
+
+After restart the browser reconnects automatically — just refresh the tab.
 
 ---