convex-mcp-visual 1.0.0 → 1.0.2

package/README.md

@@ -87,13 +87,95 @@ MCP (Model Context Protocol) is a standard protocol that allows AI assistants li
 
 ## Installation
 
-### Option 1: From GitHub (Current)
+### Option 1: npx (Recommended)
 
-Since this package is not yet published to npm, install from GitHub:
+The easiest way - no local installation needed. Works with any MCP client.
+
+**npm package:** [npmjs.com/package/convex-mcp-visual](https://www.npmjs.com/package/convex-mcp-visual)
+
+#### Claude Code (CLI)
+
+```bash
+claude mcp add convex-visual -- npx convex-mcp-visual --stdio
+```
+
+#### Claude Desktop
+
+Add to your Claude Desktop config file:
+
+**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "convex-visual": {
+      "command": "npx",
+      "args": ["convex-mcp-visual", "--stdio"]
+    }
+  }
+}
+```
+
+#### Cursor / VS Code with MCP Extension
+
+Add to your MCP settings:
+
+```json
+{
+  "mcp.servers": {
+    "convex-visual": {
+      "command": "npx",
+      "args": ["convex-mcp-visual", "--stdio"]
+    }
+  }
+}
+```
+
+#### Any MCP Client
+
+The server uses standard MCP protocol over stdio:
+
+```bash
+npx convex-mcp-visual --stdio
+```
+
+### Option 2: Global Install
+
+Install once, use anywhere:
+
+```bash
+# Install globally
+npm install -g convex-mcp-visual
+
+# Then configure your MCP client to run:
+convex-mcp-visual --stdio
+```
+
+**Claude Code:**
+```bash
+claude mcp add convex-visual -- convex-mcp-visual --stdio
+```
+
+**Claude Desktop / Other clients:**
+```json
+{
+  "mcpServers": {
+    "convex-visual": {
+      "command": "convex-mcp-visual",
+      "args": ["--stdio"]
+    }
+  }
+}
+```
+
+### Option 3: From GitHub (For Development)
+
+Clone and build locally if you want to modify the code:
 
 ```bash
 # 1. Clone the repository
-git clone https://github.com/your-username/convex-mcp-visual.git
+git clone https://github.com/waynesutton/convex-mcp-visual.git
 cd convex-mcp-visual
 
 # 2. Install dependencies
@@ -102,43 +184,41 @@ npm install
 # 3. Build the project
 npm run build
 
-# 4. Add to Claude Code (use YOUR absolute path)
-claude mcp add convex-visual -- node /Users/yourname/path/to/convex-mcp-visual/dist/index.js --stdio
+# 4. Configure your MCP client to run:
+node /absolute/path/to/convex-mcp-visual/dist/index.js --stdio
 ```
 
-**Important**: You must use the **absolute path** to `dist/index.js`. Relative paths won't work.
+**Important**: When using local installation, you must use the **absolute path** to `dist/index.js`.
 
 **Example paths:**
 - macOS: `/Users/yourname/projects/convex-mcp-visual/dist/index.js`
 - Linux: `/home/yourname/projects/convex-mcp-visual/dist/index.js`
 - Windows: `C:\Users\yourname\projects\convex-mcp-visual\dist\index.js`
 
-### Option 2: npx (After npm Publish)
-
-Once published to npm, you can use:
+### Verify Installation
 
+**Claude Code:**
 ```bash
-# Add to Claude Code directly (no clone needed)
-claude mcp add convex-visual -- npx convex-mcp-visual --stdio
+claude mcp list
+# You should see: convex-visual
 ```
 
-### Option 3: Global Install (After npm Publish)
+**Claude Desktop:**
+Restart the app, then check the MCP icon in the input area.
 
-```bash
-npm install -g convex-mcp-visual
-claude mcp add convex-visual -- convex-mcp-visual --stdio
-```
+**Other clients:**
+Check your client's MCP server status panel.
 
 ### How It Works
 
 ```
 ┌─────────────────────────────────────────────────────────────────┐
-│  claude mcp add convex-visual -- node /path/dist/index.js       │
+│  claude mcp add convex-visual -- npx convex-mcp-visual --stdio  │
 │                                                                 │
 │  This tells Claude Code:                                        │
 │  1. Register a server named "convex-visual"                     │
-│  2. When tools are needed, spawn: node /path/dist/index.js      │
-│  3. Communicate via --stdio (stdin/stdout)                      │
+│  2. When tools are needed, run: npx convex-mcp-visual           │
+│  3. Communicate via --stdio (stdin/stdout JSON-RPC)             │
 └─────────────────────────────────────────────────────────────────┘
                               │
                               ▼
@@ -823,7 +903,7 @@ When web integration becomes available, this project is designed to be ready:
 ### Development Setup
 
 ```bash
-git clone https://github.com/your-username/convex-mcp-visual.git
+git clone https://github.com/waynesutton/convex-mcp-visual.git
 cd convex-mcp-visual
 npm install
 npm run dev  # Watch mode

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convex-mcp-visual",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Visual MCP tools for exploring Convex databases - graph view, schema browser, and dashboards",
   "type": "module",
   "main": "dist/index.js",
@@ -48,8 +48,8 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/anthropics/convex-mcp-visual"
+    "url": "https://github.com/waynesutton/convex-mcp-visual"
   },
-  "author": "",
-  "homepage": "https://github.com/anthropics/convex-mcp-visual#readme"
+  "author": "Wayne Sutton",
+  "homepage": "https://github.com/waynesutton/convex-mcp-visual#readme"
 }