@contextstream/mcp-server 0.4.67 → 0.4.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +75 -138
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -24,7 +24,7 @@
24
24
  <div align="center">
25
25
 
26
26
  ```bash
27
- npx @contextstream/mcp-server@latest setup
27
+ npx --prefer-online -y @contextstream/mcp-server@latest setup
28
28
  ```
29
29
 
30
30
  </div>
@@ -35,6 +35,36 @@ npx @contextstream/mcp-server@latest setup
35
35
 
36
36
  ---
37
37
 
38
+ ## Get Started (VS Code + Copilot)
39
+
40
+ ### Option 1: Rust MCP (recommended)
41
+
42
+ ```bash
43
+ curl -fsSL https://contextstream.io/scripts/mcp.sh | bash
44
+ ```
45
+
46
+ ```powershell
47
+ irm https://contextstream.io/scripts/mcp.ps1 | iex
48
+ ```
49
+
50
+ Then run:
51
+
52
+ ```bash
53
+ contextstream-mcp setup
54
+ ```
55
+
56
+ ### Option 2: Node MCP
57
+
58
+ ```bash
59
+ npx --prefer-online -y @contextstream/mcp-server@latest setup
60
+ ```
61
+
62
+ After setup, restart VS Code/Copilot.
63
+
64
+ **Works with:** Claude Code • Cursor • VS Code • Claude Desktop • Codex CLI • OpenCode • Antigravity
65
+
66
+ ---
67
+
38
68
  ## This Isn't Just Memory. This Is Intelligence.
39
69
 
40
70
  Other tools give your AI a notepad. **ContextStream gives it a brain.**
@@ -76,56 +106,6 @@ Long conversation? ContextStream tracks token usage, auto-saves critical state,
76
106
 
77
107
  ---
78
108
 
79
- ## Choose Your Runtime (VS Code/Copilot)
80
-
81
- For VS Code + Copilot users, we recommend the Rust runtime because it gives the lowest-friction local install and startup path.
82
-
83
- ### Recommended: Rust MCP
84
-
85
- ```bash
86
- curl -fsSL https://contextstream.io/scripts/mcp.sh | bash
87
- ```
88
-
89
- ```powershell
90
- irm https://contextstream.io/scripts/mcp.ps1 | iex
91
- ```
92
-
93
- ### Alternative: Node MCP server
94
-
95
- ```bash
96
- npx --prefer-online -y @contextstream/mcp-server@latest setup
97
- ```
98
-
99
- ### Marketplace install limitation
100
-
101
- MCP marketplace installs for npm packages can install and run the package entrypoint, but they do not run arbitrary shell bootstrap commands such as `curl ... | bash` or `irm ... | iex`. That means Rust bootstrap must currently be a separate explicit user step unless/ until the Rust runtime is distributed in a marketplace-compatible package format.
102
-
103
- ## Quickest Post-Install Path (VS Code + Copilot)
104
-
105
- 1. Install a runtime (Rust recommended).
106
- 2. Run the setup wizard:
107
-
108
- ```bash
109
- contextstream-mcp setup
110
- ```
111
-
112
- 3. In wizard prompts, keep Copilot selected and confirm canonical file writes.
113
- 4. Restart VS Code/Copilot.
114
-
115
- This path is the default recommendation. Manual JSON config snippets below are backup options.
116
-
117
- ## Setup Takes 30 Seconds (Node)
118
-
119
- ```bash
120
- npx --prefer-online -y @contextstream/mcp-server@latest setup
121
- ```
122
-
123
- The wizard handles authentication, configuration, editor integration, and optional hooks that supercharge your workflow.
124
-
125
- **Works with:** Claude Code • Cursor • VS Code • Claude Desktop • Codex CLI • OpenCode • Antigravity
126
-
127
- ---
128
-
129
109
  ## The Tools Your AI Gets
130
110
 
131
111
  ```
@@ -152,8 +132,8 @@ Your AI uses these automatically. You just code.
152
132
  <summary><b>Claude Code</b></summary>
153
133
 
154
134
  ```bash
155
- claude mcp add contextstream -- npx @contextstream/mcp-server
156
- claude mcp update contextstream -e CONTEXTSTREAM_API_KEY=your_key
135
+ claude mcp add contextstream -- npx --prefer-online -y @contextstream/mcp-server@latest
136
+ claude mcp update contextstream -e CONTEXTSTREAM_API_URL=https://api.contextstream.io -e CONTEXTSTREAM_API_KEY=your_key
157
137
  ```
158
138
 
159
139
  </details>
@@ -166,8 +146,11 @@ claude mcp update contextstream -e CONTEXTSTREAM_API_KEY=your_key
166
146
  "mcpServers": {
167
147
  "contextstream": {
168
148
  "command": "npx",
169
- "args": ["-y", "@contextstream/mcp-server"],
170
- "env": { "CONTEXTSTREAM_API_KEY": "your_key" }
149
+ "args": ["--prefer-online", "-y", "@contextstream/mcp-server@latest"],
150
+ "env": {
151
+ "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
152
+ "CONTEXTSTREAM_API_KEY": "your_key"
153
+ }
171
154
  }
172
155
  }
173
156
  }
@@ -233,7 +216,10 @@ For GitHub Copilot in VS Code, use project-level MCP at `.vscode/mcp.json`.
233
216
  "type": "stdio",
234
217
  "command": "contextstream-mcp",
235
218
  "args": [],
236
- "env": { "CONTEXTSTREAM_API_KEY": "your_key" }
219
+ "env": {
220
+ "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
221
+ "CONTEXTSTREAM_API_KEY": "your_key"
222
+ }
237
223
  }
238
224
  }
239
225
  }
@@ -247,8 +233,11 @@ For GitHub Copilot in VS Code, use project-level MCP at `.vscode/mcp.json`.
247
233
  "contextstream": {
248
234
  "type": "stdio",
249
235
  "command": "npx",
250
- "args": ["-y", "@contextstream/mcp-server"],
251
- "env": { "CONTEXTSTREAM_API_KEY": "your_key" }
236
+ "args": ["--prefer-online", "-y", "@contextstream/mcp-server@latest"],
237
+ "env": {
238
+ "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
239
+ "CONTEXTSTREAM_API_KEY": "your_key"
240
+ }
252
241
  }
253
242
  }
254
243
  }
@@ -275,7 +264,10 @@ Or add to `~/.copilot/mcp-config.json` (pick one runtime):
275
264
  "contextstream": {
276
265
  "command": "contextstream-mcp",
277
266
  "args": [],
278
- "env": { "CONTEXTSTREAM_API_KEY": "your_key" }
267
+ "env": {
268
+ "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
269
+ "CONTEXTSTREAM_API_KEY": "your_key"
270
+ }
279
271
  }
280
272
  }
281
273
  }
@@ -288,8 +280,11 @@ Or add to `~/.copilot/mcp-config.json` (pick one runtime):
288
280
  "mcpServers": {
289
281
  "contextstream": {
290
282
  "command": "npx",
291
- "args": ["-y", "@contextstream/mcp-server"],
292
- "env": { "CONTEXTSTREAM_API_KEY": "your_key" }
283
+ "args": ["--prefer-online", "-y", "@contextstream/mcp-server@latest"],
284
+ "env": {
285
+ "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
286
+ "CONTEXTSTREAM_API_KEY": "your_key"
287
+ }
293
288
  }
294
289
  }
295
290
  }
@@ -301,83 +296,25 @@ For more information, see the [GitHub Copilot CLI documentation](https://docs.gi
301
296
 
302
297
  ---
303
298
 
304
- ## VS Code + Copilot Canonical Setup
305
-
306
- Select Copilot in setup; setup handles both configs automatically.
307
-
308
- For the most reliable Copilot behavior with ContextStream, configure all three artifacts:
309
-
310
- 1. **Global Copilot CLI MCP config**: `~/.copilot/mcp-config.json`
311
- 2. **Project VS Code MCP config**: `.vscode/mcp.json`
312
- 3. **Project rules and skill files**:
313
- - `.github/copilot-instructions.md`
314
- - `.github/skills/contextstream-workflow/SKILL.md`
315
-
316
- This gives you MCP connectivity plus explicit no-hooks workflow guidance for Copilot sessions.
317
-
318
- If you installed Rust MCP, use `contextstream-mcp` as the command in both MCP files. If you installed via npm/marketplace, use `npx --prefer-online -y @contextstream/mcp-server@latest`.
319
-
320
- ## Troubleshooting (Why Copilot/VS Code "isn't working")
321
-
322
- - **Wrong config location**: verify both `~/.copilot/mcp-config.json` and `.vscode/mcp.json` for project-specific VS Code usage.
323
- - **Malformed JSON**: remove comments/trailing commas in MCP JSON files.
324
- - **Stale config shape**: ensure root keys are correct (`mcpServers` for Copilot CLI, `servers` for VS Code).
325
- - **Rules missing**: ensure `.github/copilot-instructions.md` and the companion `SKILL.md` exist.
326
- - **Context discipline not followed**: first turn must call `init(...)` then `context(...)`; subsequent turns should call `context(...)` first.
327
- - **Indexing not ready**: after setup, allow indexing to complete; retry `search(mode="auto", ...)` before falling back to local scans.
328
-
329
- ## Migration Notes
330
-
331
- - If you previously configured only one path, migrate to the canonical setup above.
332
- - If migrating from Node to Rust MCP, update both command fields (`~/.copilot/mcp-config.json` and `.vscode/mcp.json`) from `npx ... @contextstream/mcp-server@latest` to `contextstream-mcp`.
333
- - If older rules exist, regenerate rules and replace stale instructions with the current Copilot files.
334
- - Preserve other MCP servers in your JSON files; only update the `contextstream` entry.
335
-
336
- ## Marketplace + Rust MCP Feasibility
337
-
338
- - Current `server.json` marketplace metadata for this package points to npm install, which is why one-click install resolves to Node MCP.
339
- - Marketplace clients do not execute external bootstrap scripts during package install, so they cannot trigger Rust install commands directly.
340
- - Once Rust MCP is published in a marketplace-supported package form (for example an additional registry package entry), `server.json` can expose both Node and Rust install targets for true one-click runtime choice.
341
-
342
- ## Hook Coverage Matrix (Claude, Cursor, Antigravity)
343
-
344
- | Editor | Hook support | ContextStream strategy |
345
- |--------|--------------|------------------------|
346
- | Claude Code | Full lifecycle hooks | Hard enforcement + reminders + lifecycle persistence hooks |
347
- | Cursor | Lifecycle hooks (tool/MCP/shell/file/session) | Hard enforcement + reminder hooks + post-action indexing hooks |
348
- | Windsurf | Cascade hooks (pre/post tool and response events) | Hard enforcement via pre hooks + post-write/session hooks |
349
- | Antigravity | No documented lifecycle hooks | Strict rules-first flow + no-hooks operational guardrails |
350
-
351
- ## Troubleshooting (ContextStream was skipped)
352
-
353
- - **Claude Code**
354
- - Confirm hooks exist in `~/.claude/settings.json` or project `.claude/settings.json`.
355
- - Verify ContextStream hook commands are present for `PreToolUse`, `UserPromptSubmit`, `SessionStart`, and `PreCompact`.
356
- - Check `CONTEXTSTREAM_HOOK_ENABLED` is not set to `false`.
357
- - **Cursor**
358
- - Confirm `.cursor/hooks.json` includes `preToolUse` and `beforeSubmitPrompt`.
359
- - Verify `beforeMCPExecution` / `beforeShellExecution` / `beforeReadFile` hook entries exist after setup.
360
- - If hooks are stale, rerun setup to regenerate ContextStream entries without deleting user hooks.
361
- - **Antigravity**
362
- - Verify `~/.gemini/antigravity/mcp_config.json` has a healthy `contextstream` server block.
363
- - Since hooks are unavailable, enforce manual discipline: `init(...)` then `context(...)`, and `search(mode="auto", ...)` before local scans.
364
- - Re-index when search appears stale and retry ContextStream search before fallback.
365
- - **Windsurf**
366
- - Confirm `~/.codeium/windsurf/mcp_config.json` includes `contextstream`.
367
- - Confirm hooks in `~/.codeium/windsurf/hooks.json` include `pre_mcp_tool_use` and `pre_user_prompt`.
368
- - If behavior is stale, rerun setup to regenerate ContextStream hook entries while preserving user hooks.
369
- - **All editors**
370
- - Validate JSON shape (`mcpServers` vs `servers`) and remove trailing commas/comments.
371
- - Keep first-call protocol strict: first turn `init(...)` then `context(...)`.
372
- - Preserve non-ContextStream entries when regenerating configs.
373
-
374
- ## Rust/Node Parity Checklist
375
-
376
- - Claude hook matrix includes current lifecycle events in both Rust and Node setup flows.
377
- - Cursor hook matrix includes tool/MCP/shell/file/session enforcement hooks in both implementations.
378
- - Windsurf hook matrix includes pre/post Cascade hook coverage in both implementations.
379
- - Antigravity remains explicit no-hooks with strengthened rules guidance in both implementations.
380
- - Hook/rules installers stay idempotent and avoid deleting non-ContextStream user entries.
299
+ ## VS Code + Copilot Tips
300
+
301
+ - Run setup once and keep both config files:
302
+ - `~/.copilot/mcp-config.json`
303
+ - `.vscode/mcp.json`
304
+ - Rust install: use `contextstream-mcp` as the command.
305
+ - Node install: use `npx --prefer-online -y @contextstream/mcp-server@latest` as the command.
306
+ - Use `mcpServers` in Copilot CLI config and `servers` in VS Code config.
307
+
308
+ ## Quick Troubleshooting
309
+
310
+ - Remove duplicate ContextStream entries across Workspace/User config scopes.
311
+ - Check `CONTEXTSTREAM_API_URL` and `CONTEXTSTREAM_API_KEY` are set.
312
+ - Remove stale version pins like `@contextstream/mcp-server@0.3.xx`.
313
+ - Restart VS Code/Copilot after config changes.
314
+
315
+ ## Marketplace Note
316
+
317
+ Marketplace npm installs can pin Node MCP versions and do not run external bootstrap scripts (`curl ... | bash` / `irm ... | iex`). Use the Rust install command directly when you want the Rust runtime.
381
318
 
382
319
  ---
383
320
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@contextstream/mcp-server",
3
3
  "mcpName": "io.github.contextstreamio/mcp-server",
4
- "version": "0.4.67",
4
+ "version": "0.4.68",
5
5
  "description": "ContextStream MCP server - v0.4.x with consolidated domain tools (~11 tools, ~75% token reduction). Code context, memory, search, and AI tools.",
6
6
  "type": "module",
7
7
  "license": "MIT",