convex-mcp-visual 1.4.7 → 1.5.0

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.
package/README.md CHANGED
@@ -7,6 +7,7 @@ Schema visualizer and dashboard tools for exploring Convex databases. Opens inte
7
7
  **Features:**
8
8
 
9
9
  - Schema browser with graph view, list view, and document browser
10
+ - Component browser for viewing installed Convex components
10
11
  - Real-time dashboard with metrics and charts
11
12
  - Mermaid ER diagrams with relationship detection
12
13
  - Codebase subway map for files and imports
@@ -45,6 +46,7 @@ convex-mcp-visual --setup
45
46
 
46
47
  # Use it
47
48
  convex-mcp-visual schema # Browse schema
49
+ convex-mcp-visual components # Browse installed components
48
50
  convex-mcp-visual dashboard # View metrics
49
51
  convex-mcp-visual diagram # Generate ER diagram
50
52
  convex-mcp-visual subway # Codebase subway map
@@ -97,13 +99,12 @@ cd my-convex-app/
97
99
  npx convex-mcp-visual --setup
98
100
  ```
99
101
 
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.
102
+ The setup wizard detects your project from `.env.local` and saves the deploy key per-project. Just copy and paste the key from the Convex dashboard.
101
103
 
102
- Or set the environment variable manually:
103
-
104
- ```bash
105
- export CONVEX_DEPLOY_KEY="prod:your-deployment|your-key"
106
- ```
104
+ > **Do not add `export CONVEX_DEPLOY_KEY=...` to your shell profile** (`~/.zshrc`,
105
+ > `~/.bashrc`, etc.). A global export overrides all per-project `.env.local` files and
106
+ > connects every project to the same deployment. If you already did this, see
107
+ > [Troubleshooting](#troubleshooting) for removal steps.
107
108
 
108
109
  Get your deploy key from [dashboard.convex.dev](https://dashboard.convex.dev) under Settings > Deploy Keys.
109
110
 
@@ -144,6 +145,9 @@ npx convex-mcp-visual --test
144
145
  | "What tables do I have?" | `schema_browser` (graph view) |
145
146
  | "Browse my database" | `schema_browser` (graph view) |
146
147
  | "Show schema for users table" | `schema_browser` with table param |
148
+ | "Show installed components" | `component_browser` |
149
+ | "What components are installed?" | `component_browser` |
150
+ | "Show agent component" | `component_browser` with filter |
147
151
  | "Create a dashboard for my data" | `dashboard_view` |
148
152
  | "Show me metrics for my app" | `dashboard_view` |
149
153
  | "Generate a diagram of my schema" | `schema_diagram` (Mermaid ER) |
@@ -165,6 +169,14 @@ All tools open an interactive browser UI and return output to the terminal. The
165
169
  - ASCII/Unicode output for terminal
166
170
  - SVG diagram in browser with theme options
167
171
  - Exportable Mermaid code
172
+ - Component grouping support
173
+
174
+ **Component Browser Features:**
175
+
176
+ - Lists all installed Convex components
177
+ - Detects known component types (agent, auth, ratelimiter, etc.)
178
+ - Shows component table schemas and document counts
179
+ - Components tab integrated in Schema Browser UI
168
180
 
169
181
  ## Documentation
170
182
 
@@ -364,6 +376,73 @@ codex mcp remove convex-visual
364
376
  npm uninstall -g convex-mcp-visual
365
377
  ```
366
378
 
379
+ ## Troubleshooting
380
+
381
+ ### Wrong deployment or stuck deploy key
382
+
383
+ If the tool keeps connecting to the wrong Convex deployment, a global config is overriding your local project settings.
384
+
385
+ **1. Check what config is active:**
386
+
387
+ ```bash
388
+ npx convex-mcp-visual --config
389
+ ```
390
+
391
+ **2. Clear the global environment variable:**
392
+
393
+ ```bash
394
+ unset CONVEX_DEPLOY_KEY
395
+ echo $CONVEX_DEPLOY_KEY
396
+ ```
397
+
398
+ If the variable reappears in new terminals, it was added to a shell profile. Open the file in your editor and delete the `export CONVEX_DEPLOY_KEY=...` line:
399
+
400
+ | OS | File to check |
401
+ | --- | --- |
402
+ | macOS (zsh) | `~/.zshrc` or `~/.zprofile` |
403
+ | macOS (bash) | `~/.bash_profile` or `~/.bashrc` |
404
+ | Linux (bash) | `~/.bashrc` or `~/.profile` |
405
+ | Linux (zsh) | `~/.zshrc` |
406
+ | Windows (PowerShell) | Run `[Environment]::SetEnvironmentVariable("CONVEX_DEPLOY_KEY", $null, "User")` |
407
+ | Windows (System) | Settings > System > Advanced > Environment Variables |
408
+
409
+ After removing the line, open a new terminal to confirm it is gone.
410
+
411
+ **3. Remove the legacy global config file:**
412
+
413
+ ```bash
414
+ rm ~/.convex-mcp-visual.json
415
+ ```
416
+
417
+ This file was created by older versions of `--setup`. Removing it lets per-project `.env.local` files take priority.
418
+
419
+ **4. Use per-project config:**
420
+
421
+ In each Convex project folder, run `--setup` or create a `.env.local` file:
422
+
423
+ ```
424
+ CONVEX_DEPLOY_KEY="prod:your-deployment-name|your-admin-key"
425
+ ```
426
+
427
+ **5. Verify:**
428
+
429
+ ```bash
430
+ npx convex-mcp-visual --test
431
+ ```
432
+
433
+ ### Config priority
434
+
435
+ The first source found wins:
436
+
437
+ 1. `CONVEX_DEPLOY_KEY` environment variable (highest priority)
438
+ 2. `CONVEX_URL` environment variable
439
+ 3. `.env.local` in the current directory
440
+ 4. `.convex/deployment.json` in the current directory
441
+ 5. `~/.convex/config.json` (Convex CLI login session)
442
+ 6. `~/.convex-mcp-visual.json` (legacy global fallback)
443
+
444
+ For more issues, see [Troubleshooting docs](docs/troubleshooting.md).
445
+
367
446
  ## Contributing
368
447
 
369
448
  See [Development](docs/architecture.md) for build instructions.
@@ -7,7 +7,7 @@
7
7
  <title>Kanban Board - Convex MCP Apps</title>
8
8
  <script type="module" crossorigin src="../../assets/kanban-board-B3LBzk3P.js"></script>
9
9
  <link rel="modulepreload" crossorigin href="../../assets/modulepreload-polyfill-B5Qt9EMX.js">
10
- <link rel="stylesheet" crossorigin href="../../assets/style-C_-VyIe_.css">
10
+ <link rel="stylesheet" crossorigin href="../../assets/style-C5Anu08Y.css">
11
11
  </head>
12
12
  <body>
13
13
  <div id="app"></div>
@@ -7,7 +7,7 @@
7
7
  <title>Realtime Dashboard - Convex MCP Apps</title>
8
8
  <script type="module" crossorigin src="../../assets/realtime-dashboard-D9nem8DB.js"></script>
9
9
  <link rel="modulepreload" crossorigin href="../../assets/modulepreload-polyfill-B5Qt9EMX.js">
10
- <link rel="stylesheet" crossorigin href="../../assets/style-C_-VyIe_.css">
10
+ <link rel="stylesheet" crossorigin href="../../assets/style-C5Anu08Y.css">
11
11
  </head>
12
12
  <body>
13
13
  <div id="app"></div>
@@ -5,9 +5,9 @@
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
6
6
  <meta name="theme-color" content="#faf8f5" />
7
7
  <title>Schema Browser - Convex MCP Apps</title>
8
- <script type="module" crossorigin src="../../assets/schema-browser-S5aw9ecT.js"></script>
8
+ <script type="module" crossorigin src="../../assets/schema-browser-D1dGKaRh.js"></script>
9
9
  <link rel="modulepreload" crossorigin href="../../assets/modulepreload-polyfill-B5Qt9EMX.js">
10
- <link rel="stylesheet" crossorigin href="../../assets/style-C_-VyIe_.css">
10
+ <link rel="stylesheet" crossorigin href="../../assets/style-C5Anu08Y.css">
11
11
  </head>
12
12
  <body>
13
13
  <div id="app"></div>