convex-mcp-visual 1.0.0 → 1.0.1
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 +36 -19
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -87,13 +87,37 @@ MCP (Model Context Protocol) is a standard protocol that allows AI assistants li
|
|
|
87
87
|
|
|
88
88
|
## Installation
|
|
89
89
|
|
|
90
|
-
### Option 1:
|
|
90
|
+
### Option 1: npx (Recommended)
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
The easiest way - no local installation needed:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
claude mcp add convex-visual -- npx convex-mcp-visual --stdio
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
That's it! Claude Code will automatically download and run the package from npm.
|
|
99
|
+
|
|
100
|
+
**npm package:** [npmjs.com/package/convex-mcp-visual](https://www.npmjs.com/package/convex-mcp-visual)
|
|
101
|
+
|
|
102
|
+
### Option 2: Global Install
|
|
103
|
+
|
|
104
|
+
Install once, use anywhere:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# Install globally
|
|
108
|
+
npm install -g convex-mcp-visual
|
|
109
|
+
|
|
110
|
+
# Add to Claude Code
|
|
111
|
+
claude mcp add convex-visual -- convex-mcp-visual --stdio
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Option 3: From GitHub (For Development)
|
|
115
|
+
|
|
116
|
+
Clone and build locally if you want to modify the code:
|
|
93
117
|
|
|
94
118
|
```bash
|
|
95
119
|
# 1. Clone the repository
|
|
96
|
-
git clone https://github.com/
|
|
120
|
+
git clone https://github.com/waynesutton/convex-mcp-visual.git
|
|
97
121
|
cd convex-mcp-visual
|
|
98
122
|
|
|
99
123
|
# 2. Install dependencies
|
|
@@ -106,39 +130,32 @@ npm run build
|
|
|
106
130
|
claude mcp add convex-visual -- node /Users/yourname/path/to/convex-mcp-visual/dist/index.js --stdio
|
|
107
131
|
```
|
|
108
132
|
|
|
109
|
-
**Important**:
|
|
133
|
+
**Important**: When using local installation, you must use the **absolute path** to `dist/index.js`.
|
|
110
134
|
|
|
111
135
|
**Example paths:**
|
|
112
136
|
- macOS: `/Users/yourname/projects/convex-mcp-visual/dist/index.js`
|
|
113
137
|
- Linux: `/home/yourname/projects/convex-mcp-visual/dist/index.js`
|
|
114
138
|
- Windows: `C:\Users\yourname\projects\convex-mcp-visual\dist\index.js`
|
|
115
139
|
|
|
116
|
-
###
|
|
117
|
-
|
|
118
|
-
Once published to npm, you can use:
|
|
140
|
+
### Verify Installation
|
|
119
141
|
|
|
120
142
|
```bash
|
|
121
|
-
#
|
|
122
|
-
claude mcp
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
### Option 3: Global Install (After npm Publish)
|
|
143
|
+
# Check it's registered
|
|
144
|
+
claude mcp list
|
|
126
145
|
|
|
127
|
-
|
|
128
|
-
npm install -g convex-mcp-visual
|
|
129
|
-
claude mcp add convex-visual -- convex-mcp-visual --stdio
|
|
146
|
+
# You should see: convex-visual
|
|
130
147
|
```
|
|
131
148
|
|
|
132
149
|
### How It Works
|
|
133
150
|
|
|
134
151
|
```
|
|
135
152
|
┌─────────────────────────────────────────────────────────────────┐
|
|
136
|
-
│ claude mcp add convex-visual --
|
|
153
|
+
│ claude mcp add convex-visual -- npx convex-mcp-visual --stdio │
|
|
137
154
|
│ │
|
|
138
155
|
│ This tells Claude Code: │
|
|
139
156
|
│ 1. Register a server named "convex-visual" │
|
|
140
|
-
│ 2. When tools are needed,
|
|
141
|
-
│ 3. Communicate via --stdio (stdin/stdout)
|
|
157
|
+
│ 2. When tools are needed, run: npx convex-mcp-visual │
|
|
158
|
+
│ 3. Communicate via --stdio (stdin/stdout JSON-RPC) │
|
|
142
159
|
└─────────────────────────────────────────────────────────────────┘
|
|
143
160
|
│
|
|
144
161
|
▼
|
|
@@ -823,7 +840,7 @@ When web integration becomes available, this project is designed to be ready:
|
|
|
823
840
|
### Development Setup
|
|
824
841
|
|
|
825
842
|
```bash
|
|
826
|
-
git clone https://github.com/
|
|
843
|
+
git clone https://github.com/waynesutton/convex-mcp-visual.git
|
|
827
844
|
cd convex-mcp-visual
|
|
828
845
|
npm install
|
|
829
846
|
npm run dev # Watch mode
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "convex-mcp-visual",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Visual MCP tools for exploring Convex databases - graph view, schema browser, and dashboards",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -48,8 +48,8 @@
|
|
|
48
48
|
"license": "MIT",
|
|
49
49
|
"repository": {
|
|
50
50
|
"type": "git",
|
|
51
|
-
"url": "https://github.com/
|
|
51
|
+
"url": "https://github.com/waynesutton/convex-mcp-visual"
|
|
52
52
|
},
|
|
53
|
-
"author": "",
|
|
54
|
-
"homepage": "https://github.com/
|
|
53
|
+
"author": "Wayne Sutton",
|
|
54
|
+
"homepage": "https://github.com/waynesutton/convex-mcp-visual#readme"
|
|
55
55
|
}
|