pg-mcp-for-devs 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# pg-mcp-for-devs
+
+Postgres MCP server for developers. **Unlike the official server, this allows arbitrary read/write SQL execution** — not just read-only queries.
+
+## Tools
+
+- `execute_sql` — run any SQL (SELECT / INSERT / UPDATE / DELETE / DDL)
+- `list_tables` — list tables in `public`
+- `describe_table` — columns, types, nullability, defaults
+
+## Quick setup
+
+Copy the example for your client from [`examples/`](./examples), set `DATABASE_URL`, and reload the MCP servers.
+
+Requires Node 18+.
+
+### Cursor
+
+Copy [`examples/cursor/mcp.json`](./examples/cursor/mcp.json) to:
+
+- Project: `.cursor/mcp.json`
+- Global: `~/.cursor/mcp.json`
+
+```json
+{
+  "mcpServers": {
+    "pg-mcp-for-devs": {
+      "command": "npx",
+      "args": ["-y", "pg-mcp-for-devs"],
+      "env": {
+        "DATABASE_URL": "postgresql://user:password@localhost:5432/mydb"
+      }
+    }
+  }
+}
+```
+
+### Claude Code
+
+Copy [`examples/claude-code/mcp.json`](./examples/claude-code/mcp.json) to project-root `.mcp.json` (or merge into `~/.claude.json`).
+
+Set `DATABASE_URL` in your shell / environment — the example expands `${DATABASE_URL}`.
+
+```bash
+export DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
+```
+
+Or:
+
+```bash
+claude mcp add --scope project --env DATABASE_URL="$DATABASE_URL" -- npx -y pg-mcp-for-devs
+```
+
+### GitHub Copilot (VS Code)
+
+Copy [`examples/copilot/mcp.json`](./examples/copilot/mcp.json) to `.vscode/mcp.json`.
+
+Note: Copilot uses the top-level key **`servers`** (not `mcpServers`). On first start, VS Code prompts for `DATABASE_URL`.
+
+### Windsurf
+
+Merge [`examples/windsurf/mcp_config.json`](./examples/windsurf/mcp_config.json) into:
+
+- macOS / Linux: `~/.codeium/windsurf/mcp_config.json`
+- Windows: `%USERPROFILE%\.codeium\windsurf\mcp_config.json`
+
+Then refresh MCP in Cascade → Manage MCPs.
+
+## Security note
+
+`execute_sql` can run any SQL, including writes and DDL. Use against databases you trust, preferably with a least-privilege DB user.
+
+## License
+
+ISC

package/dist/index.js

@@ -0,0 +1,124 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("@modelcontextprotocol/sdk/server/index.js");
+const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
+const types_js_1 = require("@modelcontextprotocol/sdk/types.js");
+const pg_1 = require("pg");
+// 初始化数据库连接
+const pool = new pg_1.Pool({
+    connectionString: process.env.DATABASE_URL,
+});
+const server = new index_js_1.Server({
+    name: "pg-mcp-for-devs",
+    version: "1.0.0",
+}, {
+    capabilities: {
+        tools: {},
+    },
+});
+// 注册 3 个核心工具：执行SQL、列出表、查看表结构
+server.setRequestHandler(types_js_1.ListToolsRequestSchema, async () => {
+    return {
+        tools: [
+            {
+                name: "execute_sql",
+                description: "Execute arbitrary read/write SQL queries against the local Postgres database. Supports DDL, DML, DQL.",
+                inputSchema: {
+                    type: "object",
+                    properties: {
+                        query: { type: "string", description: "The SQL query to execute" },
+                        params: {
+                            type: "array",
+                            description: "Optional query parameters",
+                            items: {} // 使用空对象，在 JSON Schema 中代表允许任何类型
+                        },
+                    },
+                    required: ["query"],
+                },
+            },
+            {
+                name: "list_tables",
+                description: "List all tables in the public schema of the database.",
+                inputSchema: {
+                    type: "object",
+                    properties: {},
+                },
+            },
+            {
+                name: "describe_table",
+                description: "Get the schema (columns, data types, constraints) for a specific table.",
+                inputSchema: {
+                    type: "object",
+                    properties: {
+                        table_name: { type: "string", description: "The name of the table to describe" },
+                    },
+                    required: ["table_name"],
+                },
+            }
+        ],
+    };
+});
+// 处理工具调用
+server.setRequestHandler(types_js_1.CallToolRequestSchema, async (request) => {
+    const { name, arguments: args } = request.params;
+    try {
+        if (name === "execute_sql") {
+            const { query, params } = args;
+            const result = await pool.query(query, params || []);
+            return {
+                content: [{
+                        type: "text",
+                        text: JSON.stringify(result.rows.length ? result.rows : { success: true, rowCount: result.rowCount }, null, 2)
+                    }],
+            };
+        }
+        if (name === "list_tables") {
+            const query = `
+        SELECT table_name 
+        FROM information_schema.tables 
+        WHERE table_schema = 'public' 
+        ORDER BY table_name;
+      `;
+            const result = await pool.query(query);
+            const tables = result.rows.map(r => r.table_name);
+            return {
+                content: [{ type: "text", text: JSON.stringify({ tables }, null, 2) }],
+            };
+        }
+        if (name === "describe_table") {
+            const { table_name } = args;
+            const query = `
+        SELECT 
+          column_name, 
+          data_type, 
+          is_nullable, 
+          column_default,
+          character_maximum_length
+        FROM information_schema.columns 
+        WHERE table_schema = 'public' AND table_name = $1
+        ORDER BY ordinal_position;
+      `;
+            const result = await pool.query(query, [table_name]);
+            if (result.rows.length === 0) {
+                return { content: [{ type: "text", text: `Table '${table_name}' not found or has no columns.` }] };
+            }
+            return {
+                content: [{ type: "text", text: JSON.stringify(result.rows, null, 2) }],
+            };
+        }
+        throw new Error(`Tool ${name} not found`);
+    }
+    catch (error) {
+        return {
+            content: [{ type: "text", text: `Error: ${error.message}` }],
+            isError: true,
+        };
+    }
+});
+async function main() {
+    const transport = new stdio_js_1.StdioServerTransport();
+    await server.connect(transport);
+    console.error("Local Postgres MCP Server running with schema awareness...");
+}
+main().catch(console.error);

package/examples/claude-code/mcp.json

@@ -0,0 +1,12 @@
+{
+  "mcpServers": {
+    "pg-mcp-for-devs": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "pg-mcp-for-devs"],
+      "env": {
+        "DATABASE_URL": "${DATABASE_URL}"
+      }
+    }
+  }
+}

package/examples/copilot/mcp.json

@@ -0,0 +1,20 @@
+{
+  "inputs": [
+    {
+      "type": "promptString",
+      "id": "database_url",
+      "description": "Postgres connection string (DATABASE_URL)",
+      "password": true
+    }
+  ],
+  "servers": {
+    "pg-mcp-for-devs": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "pg-mcp-for-devs"],
+      "env": {
+        "DATABASE_URL": "${input:database_url}"
+      }
+    }
+  }
+}

package/examples/cursor/mcp.json

@@ -0,0 +1,11 @@
+{
+  "mcpServers": {
+    "pg-mcp-for-devs": {
+      "command": "npx",
+      "args": ["-y", "pg-mcp-for-devs"],
+      "env": {
+        "DATABASE_URL": "postgresql://user:password@localhost:5432/mydb"
+      }
+    }
+  }
+}

package/examples/windsurf/mcp_config.json

@@ -0,0 +1,11 @@
+{
+  "mcpServers": {
+    "pg-mcp-for-devs": {
+      "command": "npx",
+      "args": ["-y", "pg-mcp-for-devs"],
+      "env": {
+        "DATABASE_URL": "postgresql://user:password@localhost:5432/mydb"
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "pg-mcp-for-devs",
+  "version": "1.0.0",
+  "description": "Postgres MCP server with full read/write SQL — list tables, describe schema, execute arbitrary queries",
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "README.md",
+    "examples"
+  ],
+  "bin": {
+    "pg-mcp-for-devs": "dist/index.js"
+  },
+  "type": "commonjs",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "mcp",
+    "mcp-server",
+    "model-context-protocol",
+    "postgres",
+    "postgresql",
+    "postgres-mcp",
+    "sql",
+    "cursor",
+    "read-write"
+  ],
+  "author": "devandy1024",
+  "license": "ISC",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.30.0",
+    "pg": "^8.23.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.4.1",
+    "@types/pg": "^8.23.1",
+    "tsx": "^4.23.13",
+    "typescript": "^7.0.2"
+  }
+}