convex-mcp-visual 1.4.7 → 1.4.8

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 +61 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -99,12 +99,16 @@ npx convex-mcp-visual --setup
99
99
 
100
100
  The setup wizard detects your project from `.env.local` and shows which deployment to look for in the dashboard. Just copy and paste the key.
101
101
 
102
- Or set the environment variable manually:
102
+ Or set the environment variable for the current session:
103
103
 
104
104
  ```bash
105
105
  export CONVEX_DEPLOY_KEY="prod:your-deployment|your-key"
106
106
  ```
107
107
 
108
+ > **Note:** If you work with multiple Convex apps, use per-project `.env.local` files
109
+ > instead of a global export. A global `CONVEX_DEPLOY_KEY` overrides all local configs
110
+ > and connects every project to the same deployment. See [Troubleshooting](#troubleshooting).
111
+
108
112
  Get your deploy key from [dashboard.convex.dev](https://dashboard.convex.dev) under Settings > Deploy Keys.
109
113
 
110
114
  ### Multiple Convex Apps
@@ -364,6 +368,62 @@ codex mcp remove convex-visual
364
368
  npm uninstall -g convex-mcp-visual
365
369
  ```
366
370
 
371
+ ## Troubleshooting
372
+
373
+ ### Wrong deployment or stuck deploy key
374
+
375
+ If the tool keeps connecting to the wrong Convex deployment, a global config is overriding your local project settings.
376
+
377
+ **1. Check what config is active:**
378
+
379
+ ```bash
380
+ npx convex-mcp-visual --config
381
+ ```
382
+
383
+ **2. Clear the global environment variable:**
384
+
385
+ ```bash
386
+ unset CONVEX_DEPLOY_KEY
387
+ echo $CONVEX_DEPLOY_KEY
388
+ ```
389
+
390
+ If the variable reappears in new terminals, remove the `export CONVEX_DEPLOY_KEY` line from your shell profile (`~/.zshrc`, `~/.bashrc`, or `~/.zprofile`).
391
+
392
+ **3. Remove the legacy global config file:**
393
+
394
+ ```bash
395
+ rm ~/.convex-mcp-visual.json
396
+ ```
397
+
398
+ This file was created by older versions of `--setup`. Removing it lets per-project `.env.local` files take priority.
399
+
400
+ **4. Use per-project config:**
401
+
402
+ In each Convex project folder, run `--setup` or create a `.env.local` file:
403
+
404
+ ```
405
+ CONVEX_DEPLOY_KEY="prod:your-deployment-name|your-admin-key"
406
+ ```
407
+
408
+ **5. Verify:**
409
+
410
+ ```bash
411
+ npx convex-mcp-visual --test
412
+ ```
413
+
414
+ ### Config priority
415
+
416
+ The first source found wins:
417
+
418
+ 1. `CONVEX_DEPLOY_KEY` environment variable (highest priority)
419
+ 2. `CONVEX_URL` environment variable
420
+ 3. `.env.local` in the current directory
421
+ 4. `.convex/deployment.json` in the current directory
422
+ 5. `~/.convex/config.json` (Convex CLI login session)
423
+ 6. `~/.convex-mcp-visual.json` (legacy global fallback)
424
+
425
+ For more issues, see [Troubleshooting docs](docs/troubleshooting.md).
426
+
367
427
  ## Contributing
368
428
 
369
429
  See [Development](docs/architecture.md) for build instructions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "convex-mcp-visual",
3
- "version": "1.4.7",
3
+ "version": "1.4.8",
4
4
  "description": "Visual MCP tools for exploring Convex databases - schema browser, dashboard, ER diagrams. Works as CLI, MCP server, or Claude Code plugin.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",