@contextstream/mcp-server 0.3.28 → 0.3.29

package/README.md

@@ -38,6 +38,21 @@ No special syntax. No commands to learn. Just ask.
 
 ## Quickstart
 
+### Setup wizard (recommended)
+
+This interactive wizard sets up authentication, installs editor rules, and writes MCP config files for the tools you select.
+
+```bash
+npx -y @contextstream/mcp-server setup
+```
+
+Notes:
+- Uses browser/device login by default and creates an API key for you (stored locally in the config files it writes).
+- Some tools still require UI/CLI-based MCP setup (the wizard will tell you when it can’t write a config).
+- Preview changes without writing files: `npx -y @contextstream/mcp-server setup --dry-run`
+
+### Run the server
+
 Run directly (recommended for MCP configs):
 
 ```bash
@@ -53,9 +68,23 @@ contextstream-mcp
 
 ## Configure your MCP client
 
-### Cursor / VS Code / Windsurf / Claude Desktop (JSON)
+### Manual setup
 
-Add to your MCP config:
+If you ran the [setup wizard](#setup-wizard-recommended), you can usually skip this section.
+
+If you prefer to configure things by hand (or your tool can’t be auto-configured), add the ContextStream MCP server to your client using one of the examples below.
+
+### Cursor / Windsurf / Claude Desktop (JSON)
+
+These clients use the `mcpServers` JSON schema:
+
+- Cursor: `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project)
+- Windsurf: `~/.codeium/windsurf/mcp_config.json`
+- Claude Desktop:
+  - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+  - Windows: `%APPDATA%\\Claude\\claude_desktop_config.json`
+
+Many other MCP JSON clients also use this same `mcpServers` shape (including Claude Code project scope via `.mcp.json`).
 
 ```json
 {
@@ -72,6 +101,72 @@ Add to your MCP config:
 }
 ```
 
+### VS Code (`.vscode/mcp.json`)
+
+VS Code uses a different schema with a top-level `servers` map:
+
+```json
+{
+  "servers": {
+    "contextstream": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@contextstream/mcp-server"],
+      "env": {
+        "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
+        "CONTEXTSTREAM_API_KEY": "your_api_key"
+      }
+    }
+  }
+}
+```
+
+Strong recommendation: VS Code supports `inputs` so you don’t have to hardcode secrets in a committed file:
+
+```json
+{
+  "servers": {
+    "contextstream": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@contextstream/mcp-server"],
+      "env": {
+        "CONTEXTSTREAM_API_URL": "https://api.contextstream.io",
+        "CONTEXTSTREAM_API_KEY": "${input:contextstreamApiKey}"
+      }
+    }
+  },
+  "inputs": [
+    {
+      "id": "contextstreamApiKey",
+      "type": "promptString",
+      "description": "ContextStream API Key",
+      "password": true
+    }
+  ]
+}
+```
+
+### Claude Code (CLI)
+
+User scope (all projects):
+
+```bash
+claude mcp add --transport stdio contextstream --scope user \
+  --env CONTEXTSTREAM_API_URL=https://api.contextstream.io \
+  --env CONTEXTSTREAM_API_KEY=YOUR_KEY -- \
+  npx -y @contextstream/mcp-server
+```
+
+Windows caveat (native Windows, not WSL): if `npx` isn’t found, use `cmd /c npx -y @contextstream/mcp-server` after `--`.
+
+Alternative (JSON form):
+
+```bash
+claude mcp add-json contextstream \
+'{"type":"stdio","command":"npx","args":["-y","@contextstream/mcp-server"],"env":{"CONTEXTSTREAM_API_URL":"https://api.contextstream.io","CONTEXTSTREAM_API_KEY":"your_api_key"}}'
+```
+
 ### Codex CLI (`~/.codex/config.toml`)
 
 ```toml