convex-mcp-visual 1.0.1 → 1.0.2

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 +71 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -89,15 +89,56 @@ MCP (Model Context Protocol) is a standard protocol that allows AI assistants li
89
89
 
90
90
  ### Option 1: npx (Recommended)
91
91
 
92
- The easiest way - no local installation needed:
92
+ The easiest way - no local installation needed. Works with any MCP client.
93
+
94
+ **npm package:** [npmjs.com/package/convex-mcp-visual](https://www.npmjs.com/package/convex-mcp-visual)
95
+
96
+ #### Claude Code (CLI)
93
97
 
94
98
  ```bash
95
99
  claude mcp add convex-visual -- npx convex-mcp-visual --stdio
96
100
  ```
97
101
 
98
- That's it! Claude Code will automatically download and run the package from npm.
102
+ #### Claude Desktop
99
103
 
100
- **npm package:** [npmjs.com/package/convex-mcp-visual](https://www.npmjs.com/package/convex-mcp-visual)
104
+ Add to your Claude Desktop config file:
105
+
106
+ **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
107
+ **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
108
+
109
+ ```json
110
+ {
111
+ "mcpServers": {
112
+ "convex-visual": {
113
+ "command": "npx",
114
+ "args": ["convex-mcp-visual", "--stdio"]
115
+ }
116
+ }
117
+ }
118
+ ```
119
+
120
+ #### Cursor / VS Code with MCP Extension
121
+
122
+ Add to your MCP settings:
123
+
124
+ ```json
125
+ {
126
+ "mcp.servers": {
127
+ "convex-visual": {
128
+ "command": "npx",
129
+ "args": ["convex-mcp-visual", "--stdio"]
130
+ }
131
+ }
132
+ }
133
+ ```
134
+
135
+ #### Any MCP Client
136
+
137
+ The server uses standard MCP protocol over stdio:
138
+
139
+ ```bash
140
+ npx convex-mcp-visual --stdio
141
+ ```
101
142
 
102
143
  ### Option 2: Global Install
103
144
 
@@ -107,10 +148,27 @@ Install once, use anywhere:
107
148
  # Install globally
108
149
  npm install -g convex-mcp-visual
109
150
 
110
- # Add to Claude Code
151
+ # Then configure your MCP client to run:
152
+ convex-mcp-visual --stdio
153
+ ```
154
+
155
+ **Claude Code:**
156
+ ```bash
111
157
  claude mcp add convex-visual -- convex-mcp-visual --stdio
112
158
  ```
113
159
 
160
+ **Claude Desktop / Other clients:**
161
+ ```json
162
+ {
163
+ "mcpServers": {
164
+ "convex-visual": {
165
+ "command": "convex-mcp-visual",
166
+ "args": ["--stdio"]
167
+ }
168
+ }
169
+ }
170
+ ```
171
+
114
172
  ### Option 3: From GitHub (For Development)
115
173
 
116
174
  Clone and build locally if you want to modify the code:
@@ -126,8 +184,8 @@ npm install
126
184
  # 3. Build the project
127
185
  npm run build
128
186
 
129
- # 4. Add to Claude Code (use YOUR absolute path)
130
- claude mcp add convex-visual -- node /Users/yourname/path/to/convex-mcp-visual/dist/index.js --stdio
187
+ # 4. Configure your MCP client to run:
188
+ node /absolute/path/to/convex-mcp-visual/dist/index.js --stdio
131
189
  ```
132
190
 
133
191
  **Important**: When using local installation, you must use the **absolute path** to `dist/index.js`.
@@ -139,13 +197,18 @@ claude mcp add convex-visual -- node /Users/yourname/path/to/convex-mcp-visual/d
139
197
 
140
198
  ### Verify Installation
141
199
 
200
+ **Claude Code:**
142
201
  ```bash
143
- # Check it's registered
144
202
  claude mcp list
145
-
146
203
  # You should see: convex-visual
147
204
  ```
148
205
 
206
+ **Claude Desktop:**
207
+ Restart the app, then check the MCP icon in the input area.
208
+
209
+ **Other clients:**
210
+ Check your client's MCP server status panel.
211
+
149
212
  ### How It Works
150
213
 
151
214
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "convex-mcp-visual",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
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",