@cainli/mcp-server-mysql 2.0.9 → 2.0.10

package/README.md

@@ -49,6 +49,27 @@ A Model Context Protocol server that provides access to MySQL databases through
 - MySQL user with appropriate permissions for the operations you need
 - For write operations: MySQL user with INSERT, UPDATE, and/or DELETE privileges
 
+## Platform Support
+
+This MCP server is fully compatible with:
+
+- **macOS Big Sur (11.x) and later** - Full support including Unix Socket connections
+- **Windows 10 and later** - Full support via TCP/IP connections
+- **Linux** - Full support including Unix Socket connections
+
+### Platform-Specific Notes
+
+#### macOS Big Sur
+- Can use either TCP/IP or Unix Socket connections
+- Unix Socket path example: `/tmp/mysql.sock` or `/var/run/mysql.sock`
+- No additional configuration required
+
+#### Windows 10
+- Must use TCP/IP connections (Unix Sockets are not supported)
+- Ensure MySQL is configured to accept TCP/IP connections
+- Default connection: `MYSQL_HOST=127.0.0.1` and `MYSQL_PORT=3306`
+- If using WSL2, you can connect to MySQL via Windows host IP (e.g., `MYSQL_HOST=172.x.x.x`)
+
 ## Installation
 
 ### Using Smithery
@@ -514,13 +535,54 @@ For more control over the MCP server's behavior, you can use these advanced conf
 
 ### Basic Connection
 
-- `MYSQL_SOCKET_PATH`: Unix socket path for local connections (e.g., "/tmp/mysql.sock")
-- `MYSQL_HOST`: MySQL server host (default: "127.0.0.1") - ignored if MYSQL_SOCKET_PATH is set
-- `MYSQL_PORT`: MySQL server port (default: "3306") - ignored if MYSQL_SOCKET_PATH is set
+- `MYSQL_SOCKET_PATH`: Unix socket path for local connections (e.g., "/tmp/mysql.sock") - **macOS/Linux only**
+- `MYSQL_HOST`: MySQL server host (default: "127.0.0.1") - **required for Windows**
+- `MYSQL_PORT`: MySQL server port (default: "3306") - **required for Windows**
 - `MYSQL_USER`: MySQL username (default: "root")
 - `MYSQL_PASS`: MySQL password
 - `MYSQL_DB`: Target database name (leave empty for multi-DB mode)
 
+### Platform-Specific Configuration
+
+#### macOS Big Sur
+
+On macOS, you can use either Unix sockets or TCP/IP:
+
+**Option 1: Unix Socket (Recommended for local MySQL)**
+```bash
+MYSQL_SOCKET_PATH="/tmp/mysql.sock"
+MYSQL_USER="root"
+MYSQL_PASS="your_password"
+MYSQL_DB="your_database"
+```
+
+**Option 2: TCP/IP**
+```bash
+MYSQL_HOST="127.0.0.1"
+MYSQL_PORT="3306"
+MYSQL_USER="root"
+MYSQL_PASS="your_password"
+MYSQL_DB="your_database"
+```
+
+#### Windows 10
+
+On Windows, you must use TCP/IP connections:
+
+```bash
+MYSQL_HOST="127.0.0.1"
+MYSQL_PORT="3306"
+MYSQL_USER="root"
+MYSQL_PASS="your_password"
+MYSQL_DB="your_database"
+```
+
+**Windows-Specific Notes:**
+- If MySQL is running in WSL2, you may need to use the Windows host IP instead of `127.0.0.1`
+- To find WSL2 IP: Run `wsl hostname -I` in Windows Command Prompt or PowerShell
+- Ensure MySQL is configured to accept TCP/IP connections (check `bind-address` in `my.cnf` or `my.ini`)
+- Windows Firewall may block connections - ensure port 3306 is allowed
+
 #### Alternative: Connection String
 
 For scenarios requiring frequent credential rotation or temporary connections, you can use a MySQL connection string instead of individual environment variables:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cainli/mcp-server-mysql",
-  "version": "2.0.9",
+  "version": "2.0.10",
   "description": "MCP server for interacting with MySQL databases with write operations support",
   "license": "MIT",
   "author": "cainli (https://github.com/cainli)",
@@ -16,30 +16,6 @@
     "README.md",
     "assets"
   ],
-  "scripts": {
-    "start": "node dist/index.js",
-    "dev": "ts-node index.ts",
-    "build": "tsc && shx chmod +x dist/*.js",
-    "prepare": "npm run build",
-    "watch": "tsc --watch",
-    "setup:test:db": "tsx scripts/setup-test-db.ts",
-    "pretest": "pnpm run setup:test:db",
-    "test": "pnpm run setup:test:db && vitest run",
-    "test:socket": "pnpm run setup:test:db && vitest run tests/integration/socket-connection.test.ts",
-    "test:watch": "pnpm run setup:test:db && vitest",
-    "test:coverage": "vitest run --coverage",
-    "test:unit": "vitest run --config vitest.unit.config.ts",
-    "test:integration": "vitest run --config vitest.integration.config.ts",
-    "test:e2e": "vitest run --config vitest.e2e.config.ts",
-    "stdio": "node dist/index.js --stdio",
-    "exec": " pnpm build && npx node --env-file=.env dist/index.js",
-    "lint": "npm run lint:eslint && npm run lint:markdown",
-    "lint:eslint": "eslint .",
-    "lint:markdown": "markdownlint .",
-    "lint:fix": "npm run lint:eslint:fix && npm run lint:markdown:fix",
-    "lint:eslint:fix": "eslint . --fix",
-    "lint:markdown:fix": "markdownlint . --fix"
-  },
   "dependencies": {
     "@ai-sdk/openai": "^1.3.22",
     "@modelcontextprotocol/sdk": "1.15.1",
@@ -83,5 +59,29 @@
     "mcp-patch",
     "mcp-options",
     "mcp-head"
-  ]
-}
+  ],
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "ts-node index.ts",
+    "build": "tsc && npm run chmod:win",
+    "chmod:win": "node -e \"const os=require('os');if(os.platform()!=='win32'){const fs=require('fs');const dist='dist';const files=fs.readdirSync(dist).filter(f=>f.endsWith('.js'));files.forEach(f=>fs.chmodSync(dist+'/'+f,0o755));console.log('Made executable:',files.join(', '))}\"",
+    "watch": "tsc --watch",
+    "setup:test:db": "tsx scripts/setup-test-db.ts",
+    "pretest": "pnpm run setup:test:db",
+    "test": "pnpm run setup:test:db && vitest run",
+    "test:socket": "pnpm run setup:test:db && vitest run tests/integration/socket-connection.test.ts",
+    "test:watch": "pnpm run setup:test:db && vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:unit": "vitest run --config vitest.unit.config.ts",
+    "test:integration": "vitest run --config vitest.integration.config.ts",
+    "test:e2e": "vitest run --config vitest.e2e.config.ts",
+    "stdio": "node dist/index.js --stdio",
+    "exec": " pnpm build && npx node --env-file=.env dist/index.js",
+    "lint": "npm run lint:eslint && npm run lint:markdown",
+    "lint:eslint": "eslint .",
+    "lint:markdown": "markdownlint .",
+    "lint:fix": "npm run lint:eslint:fix && npm run lint:markdown:fix",
+    "lint:eslint:fix": "eslint . --fix",
+    "lint:markdown:fix": "markdownlint . --fix"
+  }
+}