convex-mcp-visual 1.0.4 → 1.0.6

package/README.md

@@ -238,11 +238,9 @@ Check your client's MCP server status panel.
 
 ## Setup
 
-### 1. Get Your Deploy Key (Required)
+### Step 1: Get Your Deploy Key
 
-You need a **deploy key** from the Convex dashboard. This is different from `npx convex login`.
-
-**Step-by-step:**
+Get a **deploy key** from the Convex dashboard:
 
 1. Go to [dashboard.convex.dev](https://dashboard.convex.dev)
 2. Select your project
@@ -252,16 +250,35 @@ You need a **deploy key** from the Convex dashboard. This is different from `npx
 6. Choose "Development" or "Production"
 7. Copy the key (format: `prod:happy-animal-123|convex_deploy_abc123...`)
 
-### 2. Add MCP Server with Deploy Key
+### Step 2: Save Your Deploy Key
 
-**For Claude Code:**
+Add the key to your shell profile so it's always available.
 
+**For macOS/Linux (zsh):**
 ```bash
-claude mcp add convex-visual -e CONVEX_DEPLOY_KEY=prod:your-deployment|your-key-here -- npx convex-mcp-visual --stdio
+echo 'export CONVEX_DEPLOY_KEY="prod:your-deployment|your-key-here"' >> ~/.zshrc
+source ~/.zshrc
 ```
 
-**For Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+**For macOS/Linux (bash):**
+```bash
+echo 'export CONVEX_DEPLOY_KEY="prod:your-deployment|your-key-here"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+**For Windows (PowerShell):**
+```powershell
+[Environment]::SetEnvironmentVariable("CONVEX_DEPLOY_KEY", "prod:your-deployment|your-key-here", "User")
+```
 
+### Step 3: Add the MCP Server
+
+**For Claude Code:**
+```bash
+claude mcp add convex-visual -- npx convex-mcp-visual --stdio
+```
+
+**For Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json`):
 ```json
 {
   "mcpServers": {
@@ -276,23 +293,77 @@ claude mcp add convex-visual -e CONVEX_DEPLOY_KEY=prod:your-deployment|your-key-
 }
 ```
 
-### 3. Verify Installation
+**For Cursor/VS Code** (MCP settings):
+```json
+{
+  "mcp.servers": {
+    "convex-visual": {
+      "command": "npx",
+      "args": ["convex-mcp-visual", "--stdio"]
+    }
+  }
+}
+```
+
+### Step 4: Verify Setup
 
 ```bash
-# Check MCP server is registered
+# Check MCP server is registered (Claude Code)
 claude mcp list
 
-# You should see: convex-visual
+# Test the connection
+npx convex-mcp-visual --test
 ```
 
-### 3. Test Connection
+You should see:
+```
+Testing Convex connection...
+✓ Connected to: https://your-deployment.convex.cloud
+✓ Found X tables: users, posts, ...
+```
+
+---
+
+## Changing or Updating Your Deploy Key
+
+To switch to a different Convex project or update your key:
+
+**1. Edit your shell profile:**
+```bash
+# Open in your editor
+nano ~/.zshrc    # or ~/.bashrc
+
+# Find and update this line:
+export CONVEX_DEPLOY_KEY="prod:new-deployment|new-key-here"
+
+# Save and reload
+source ~/.zshrc
+```
 
+**2. Test the new connection:**
 ```bash
-# If installed globally or via npx
 npx convex-mcp-visual --test
+```
 
-# If local development
-npm test
+---
+
+## Removing the MCP Server
+
+**For Claude Code:**
+```bash
+claude mcp remove convex-visual
+```
+
+**For Claude Desktop:**
+Edit `~/Library/Application Support/Claude/claude_desktop_config.json` and remove the `convex-visual` entry.
+
+**Remove the environment variable (optional):**
+```bash
+# Edit your shell profile
+nano ~/.zshrc
+
+# Delete the CONVEX_DEPLOY_KEY line, then reload
+source ~/.zshrc
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convex-mcp-visual",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Visual MCP tools for exploring Convex databases - graph view, schema browser, and dashboards",
   "type": "module",
   "main": "dist/index.js",