Skip to content

Commit c66d564

Browse files
committed
docs(extension): update README for v2.0 alignment
- Status bar table now shows actual sm: prefix format - MCP section updated from 3 to 7 tools with descriptions - Added CLI commands reference table (--diff, --health, --report, etc.) - Quick Start mentions v2 features enabled by default - Requirements table adds zero-dependency highlight - Troubleshooting shows actual sm: no context message - AI Tool Integration MCP section lists all 7 tools
1 parent 55c1b5f commit c66d564

1 file changed

Lines changed: 28 additions & 9 deletions

File tree

vscode-extension/README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ A persistent status bar item shows your context health at a glance — no need t
5858

5959
| Grade | Status bar | Meaning |
6060
|:---:|---|---|
61-
| **A** | `✔ A 2h ago` | Fresh and complete — AI has full codebase context |
62-
| **B** | `ℹ B 6h ago` | Good — minor gaps, regenerate when convenient |
63-
| **C** | `⚠ C 1d ago` | Stale — missing recent changes, regenerate soon |
64-
| **D** | `✖ D 3d ago` | Very stale or incomplete — regenerate now |
61+
| **A** | `sm: ✔ A 2h ago` | Fresh and complete — AI has full codebase context |
62+
| **B** | `sm: ℹ B 6h ago` | Good — minor gaps, regenerate when convenient |
63+
| **C** | `sm: ⚠ C 1d ago` | Stale — missing recent changes, regenerate soon |
64+
| **D** | `sm: ✖ D 3d ago` | Very stale or incomplete — regenerate now |
6565

6666
Click the status bar item to trigger an **instant regeneration**.
6767

@@ -75,10 +75,14 @@ Run `SigMap: Regenerate Context` from the Command Palette and watch the terminal
7575
SigMap scans every signature before writing. If an AWS key, GitHub token, DB connection string, or Stripe key is detected in a function signature, it's **automatically redacted** — never leaks into your context file.
7676

7777
### 🗺 MCP server support
78-
SigMap ships with a built-in **Model Context Protocol (MCP) server** for Claude and Cursor, exposing three tools:
78+
SigMap ships with a built-in **Model Context Protocol (MCP) server** for Claude and Cursor, exposing **7 tools**:
7979
- `read_context` — full or per-module signature map
8080
- `search_signatures` — keyword search across all signatures
8181
- `get_map` — import graph, class hierarchy, or route table
82+
- `create_checkpoint` — session checkpoint with git state and context snapshot
83+
- `get_routing` — model routing hints (fast/balanced/powerful tiers)
84+
- `explain_file` — signatures, imports, and callers for a specific file
85+
- `list_modules` — all top-level modules sorted by token count
8286

8387
---
8488

@@ -131,7 +135,7 @@ Open your project in VS Code, then open the Command Palette (`⇧⌘P` / `Ctrl+S
131135
SigMap: Regenerate Context
132136
```
133137

134-
This creates `.github/copilot-instructions.md` in your workspace root.
138+
This creates `.github/copilot-instructions.md` in your workspace root — including v2 sections like TODO/FIXME extraction, recent git changes, and coverage gaps (all enabled by default).
135139

136140
### Step 3 — Done
137141

@@ -146,8 +150,9 @@ GitHub Copilot automatically picks up `.github/copilot-instructions.md`. Claude,
146150
| Requirement | Details |
147151
|---|---|
148152
| **Node.js** | Version 18 or higher — [download here](https://nodejs.org) |
149-
| **sigmap CLI** | `npm install -g sigmap` or `npx sigmap` per-project |
153+
| **sigmap CLI** | `npm install -g sigmap` (v2.0.0+) or `npx sigmap` per-project |
150154
| **VS Code** | 1.85.0 or higher |
155+
| **Dependencies** | **Zero** — no npm install needed for the CLI |
151156

152157
> The extension automatically detects `gen-context.js` in your workspace root. If installed globally, set `sigmap.scriptPath` in settings.
153158
@@ -179,6 +184,20 @@ Open the Command Palette (`⇧⌘P` / `Ctrl+Shift+P`) and type **SigMap**:
179184
| `SigMap: Regenerate Context` || Runs `node gen-context.js` in your workspace root |
180185
| `SigMap: Open Context File` || Opens `.github/copilot-instructions.md` in the editor |
181186

187+
### CLI commands (terminal)
188+
189+
| Command | Description |
190+
|---|---|
191+
| `node gen-context.js` | Generate context once and exit |
192+
| `node gen-context.js --watch` | Generate + watch for changes |
193+
| `node gen-context.js --setup` | Generate + install git hook + start watcher |
194+
| `node gen-context.js --diff <base>` | Show changed-file signatures vs a git ref |
195+
| `node gen-context.js --health` | Print context health grade |
196+
| `node gen-context.js --report` | Token reduction stats to stdout |
197+
| `node gen-context.js --report --json` | Token report as JSON (for CI) |
198+
| `node gen-context.js --mcp` | Start MCP server on stdio |
199+
| `node gen-context.js --init` | Write example config file |
200+
182201
---
183202

184203
## 🏗 How It Works
@@ -248,7 +267,7 @@ Add `.windsurfrules` output:
248267
```bash
249268
node gen-context.js --mcp
250269
```
251-
Exposes `read_context`, `search_signatures`, `get_map` over stdio JSON-RPC.
270+
Exposes 7 tools over stdio JSON-RPC: `read_context`, `search_signatures`, `get_map`, `create_checkpoint`, `get_routing`, `explain_file`, `list_modules`.
252271

253272
---
254273

@@ -267,7 +286,7 @@ Use SigMap for every session. Reach for Repomix when you need full file content.
267286

268287
## 🐛 Troubleshooting
269288

270-
**Status bar shows "no context"**
289+
**Status bar shows `sm: no context`**
271290
→ Run `SigMap: Regenerate Context`. If it fails, check that Node.js 18+ is installed: `node --version`
272291

273292
**"gen-context.js not found" warning**

0 commit comments

Comments
 (0)