convex-mcp-visual 1.1.2 → 1.1.3
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 +4 -2
- package/package.json +1 -1
- package/skills/convex-schema/SKILL.md +34 -6
package/README.md
CHANGED
|
@@ -131,12 +131,14 @@ All tools open an interactive browser UI and return output to the terminal.
|
|
|
131
131
|
|
|
132
132
|
## Documentation
|
|
133
133
|
|
|
134
|
-
- [Setup Guide](docs/setup.md) -
|
|
135
|
-
- [Plugin Distribution](deployplugin.md) - Claude Code plugin marketplace
|
|
134
|
+
- [Setup Guide](docs/setup.md) - Configuration and MCP client setup
|
|
136
135
|
- [Tools Reference](docs/tools.md) - Parameters and keyboard shortcuts
|
|
137
136
|
- [Architecture](docs/architecture.md) - How it works
|
|
138
137
|
- [Troubleshooting](docs/troubleshooting.md) - Common issues and fixes
|
|
139
138
|
- [Limitations](docs/limitations.md) - Known limitations
|
|
139
|
+
- [Plugin Distribution](docs/deployplugin.md) - Claude Code marketplace
|
|
140
|
+
- [User Guide: Schema Browser](docs/user-guide-schema-browser.md) - Using the schema browser
|
|
141
|
+
- [User Guide: Dashboard](docs/user-guide-dashboard.md) - Using the dashboard
|
|
140
142
|
|
|
141
143
|
## Configuration
|
|
142
144
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "convex-mcp-visual",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
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",
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: convex-schema
|
|
3
|
-
description: Browse and visualize Convex database schemas. Use when exploring Convex tables, viewing document structure,
|
|
3
|
+
description: Browse and visualize Convex database schemas. Use when exploring Convex tables, viewing document structure, understanding database relationships, or creating dashboards.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Convex Schema Browser
|
|
7
7
|
|
|
8
|
-
Use the
|
|
8
|
+
Use the MCP tools to explore Convex databases interactively.
|
|
9
9
|
|
|
10
10
|
## When to use
|
|
11
11
|
|
|
@@ -13,14 +13,40 @@ Use the `schema_browser` MCP tool to explore Convex database schemas interactive
|
|
|
13
13
|
- User wants to browse tables or documents
|
|
14
14
|
- User needs to understand database structure
|
|
15
15
|
- User asks about table relationships
|
|
16
|
+
- User wants to visualize their data
|
|
17
|
+
- User asks for metrics or dashboard
|
|
16
18
|
|
|
17
19
|
## Available tools
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
### schema_browser
|
|
20
22
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
23
|
+
Interactive schema explorer with graph and list views.
|
|
24
|
+
|
|
25
|
+
**Parameters:**
|
|
26
|
+
|
|
27
|
+
- `table` (string, optional): Pre-select a specific table
|
|
28
|
+
- `showInferred` (boolean, default: true): Show inferred schemas
|
|
29
|
+
- `pageSize` (number, default: 50): Documents per page
|
|
30
|
+
|
|
31
|
+
### dashboard_view
|
|
32
|
+
|
|
33
|
+
Real-time metrics dashboard with charts.
|
|
34
|
+
|
|
35
|
+
**Parameters:**
|
|
36
|
+
|
|
37
|
+
- `metrics` (array): Metric definitions with aggregations
|
|
38
|
+
- `charts` (array): Chart configurations (line, bar, pie)
|
|
39
|
+
- `refreshInterval` (number, default: 5): Refresh interval in seconds
|
|
40
|
+
|
|
41
|
+
### schema_diagram
|
|
42
|
+
|
|
43
|
+
Mermaid ER diagrams showing table relationships.
|
|
44
|
+
|
|
45
|
+
**Parameters:**
|
|
46
|
+
|
|
47
|
+
- `theme` (string): Color theme (github-dark, dracula, nord, etc.)
|
|
48
|
+
- `ascii` (boolean): Use ASCII output for terminal
|
|
49
|
+
- `tables` (array): Specific tables to include
|
|
24
50
|
|
|
25
51
|
## Example prompts
|
|
26
52
|
|
|
@@ -30,6 +56,8 @@ This skill provides access to these MCP tools:
|
|
|
30
56
|
- "Show schema for the users table"
|
|
31
57
|
- "Generate a diagram of my schema"
|
|
32
58
|
- "Create a dashboard for my data"
|
|
59
|
+
- "Show me metrics for my app"
|
|
60
|
+
- "Visualize my database relationships"
|
|
33
61
|
|
|
34
62
|
## Requirements
|
|
35
63
|
|