convex-mcp-visual 1.4.8 → 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 +30 -11
- package/dist/apps/apps/kanban-board/index.html +1 -1
- package/dist/apps/apps/realtime-dashboard/index.html +1 -1
- package/dist/apps/apps/schema-browser/index.html +2 -2
- package/dist/apps/assets/schema-browser-D1dGKaRh.js +786 -0
- package/dist/apps/assets/{style-C_-VyIe_.css → style-C5Anu08Y.css} +1 -1
- package/dist/convex-client.d.ts +42 -0
- package/dist/convex-client.d.ts.map +1 -1
- package/dist/convex-client.js +147 -6
- package/dist/convex-client.js.map +1 -1
- package/dist/index.js +82 -9
- package/dist/index.js.map +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +12 -0
- package/dist/server.js.map +1 -1
- package/dist/tools/component-browser.d.ts +19 -0
- package/dist/tools/component-browser.d.ts.map +1 -0
- package/dist/tools/component-browser.js +233 -0
- package/dist/tools/component-browser.js.map +1 -0
- package/dist/tools/schema-diagram.d.ts.map +1 -1
- package/dist/tools/schema-diagram.js +68 -14
- package/dist/tools/schema-diagram.js.map +1 -1
- package/package.json +4 -2
- package/dist/apps/assets/schema-browser-S5aw9ecT.js +0 -567
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,17 +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
|
|
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
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
```
|
|
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).
|
|
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.
|
|
111
108
|
|
|
112
109
|
Get your deploy key from [dashboard.convex.dev](https://dashboard.convex.dev) under Settings > Deploy Keys.
|
|
113
110
|
|
|
@@ -148,6 +145,9 @@ npx convex-mcp-visual --test
|
|
|
148
145
|
| "What tables do I have?" | `schema_browser` (graph view) |
|
|
149
146
|
| "Browse my database" | `schema_browser` (graph view) |
|
|
150
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 |
|
|
151
151
|
| "Create a dashboard for my data" | `dashboard_view` |
|
|
152
152
|
| "Show me metrics for my app" | `dashboard_view` |
|
|
153
153
|
| "Generate a diagram of my schema" | `schema_diagram` (Mermaid ER) |
|
|
@@ -169,6 +169,14 @@ All tools open an interactive browser UI and return output to the terminal. The
|
|
|
169
169
|
- ASCII/Unicode output for terminal
|
|
170
170
|
- SVG diagram in browser with theme options
|
|
171
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
|
|
172
180
|
|
|
173
181
|
## Documentation
|
|
174
182
|
|
|
@@ -387,7 +395,18 @@ unset CONVEX_DEPLOY_KEY
|
|
|
387
395
|
echo $CONVEX_DEPLOY_KEY
|
|
388
396
|
```
|
|
389
397
|
|
|
390
|
-
If the variable reappears in new terminals,
|
|
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.
|
|
391
410
|
|
|
392
411
|
**3. Remove the legacy global config file:**
|
|
393
412
|
|
|
@@ -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-
|
|
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-
|
|
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-
|
|
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-
|
|
10
|
+
<link rel="stylesheet" crossorigin href="../../assets/style-C5Anu08Y.css">
|
|
11
11
|
</head>
|
|
12
12
|
<body>
|
|
13
13
|
<div id="app"></div>
|