MCP Postgres Query Server

🚀 MCP PostgreSQL 查詢服務器

本項目是一個模型上下文協議（MCP）服務器實現，專為以只讀模式查詢 PostgreSQL 數據庫而設計。它能與 Claude Desktop 及其他 MCP 客戶端協同工作，為用戶提供安全、便捷的數據庫查詢服務。

🚀 快速開始

先決條件

• Node.js（v14 或更高版本）
• npm（隨 Node.js 提供）
• PostgreSQL 數據庫（通過命令行提供的連接詳細信息）

安裝

# 克隆倉庫
git clone https://github.com/RathodDarshil/mcp-postgres-query-server.git
cd mcp-postgres-query-server

# 安裝依賴項
npm install

# 構建項目
npm run build

與 Claude Desktop 連接

您可以配置 Claude Desktop 以自動啟動並連接到 MCP 服務器：

1. 訪問 Claude Desktop 的配置文件：
   • 打開 Claude Desktop
   • 轉到設置 > 開發者 > 編輯配置
   • 這將在默認文本編輯器中打開配置文件
2. 在 claude_desktop_config.json 的 mcpServers 部分添加 postgres-query-server：

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/path/to/your/mcp-postgres-query-server/dist/index.js",
                "postgresql://username:password@hostname:port/database"
            ]
        }
    }
}

3. 用實際項目目錄的實際路徑替換 /path/to/your/
4. 用實際的 PostgreSQL 連接字符串替換數據庫憑據
5. 保存文件並重新啟動 Claude Desktop。MCP 服務器應該現在出現在設置中的 MCP 服務器選擇下拉菜單中

配置示例

以下是帶有 postgres-query 的配置文件完整示例：

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/Users/darshilrathod/mcp-servers/mcp-postgres-query-server/dist/index.js",
                "postgresql://user:password@localhost:5432/mydatabase"
            ]
        }
    }
}

配置更新

要更新 Claude Desktop 配置：

1. 打開 Claude Desktop
2. 轉到設置 > 開發者 > 編輯配置
3. 在配置文件中進行更改
4. 保存文件
5. 重新啟動 Claude Desktop 以使更改生效
6. 如果您已更新 MCP 服務器代碼，請在重新啟動之前使用 npm run build 進行重建

✨ 主要特性

• 只讀數據庫訪問：僅允許 SELECT 查詢，確保安全
• 查詢驗證：防止潛在有害的 SQL 操作
• 超時保護：運行時間超過 10 秒的查詢將被自動終止
• MCP 協議支持：完整的模型上下文協議實現
• JSON 響應格式化：查詢結果以結構化的 JSON 格式返回

📚 詳細文檔

API

工具

query-postgres

對配置好的 PostgreSQL 數據庫執行只讀 SQL 查詢。

• 參數：
  • query（字符串）：要執行的 SQL SELECT 查詢
• 響應：
  • JSON 對象包含：
    • rows：結果集行
    • columns：列信息
    • rowCount：行數
    • type：查詢類型

示例請求

{
  "procedure": "query-postgres",
  "params": {
    "query": "SELECT * FROM users LIMIT 10"
  }
}

示例響應

{
  "rows": [
    { "id": 1, "name": "Alice" },
    { "id": 2, "name": "Bob" }
  ],
  "columns": ["id", "name"],
  "rowCount": 2,
  "type": "SELECT"
}

開發

配置 PostgreSQL 連接

在 config.js 文件中，配置 PostgreSQL 連接詳細信息：

module.exports = {
    host: 'localhost',
    port: 5432,
    user: 'yourdbuser',
    password: 'yourdbpassword',
    database: 'yourdatabasename'
};

運行查詢

在 index.js 文件中，定義處理查詢的邏輯：

const { Pool } = require('pg');
const pool = new Pool(require('./config'));

async function queryPostgres(query) {
    try {
        const result = await pool.query(query);
        return {
            rows: Array.from(result.rows),
            columns: result.columns,
            rowCount: result.rowCount,
            type: result.command
        };
    } catch (error) {
        throw new Error(`Query failed: ${error.message}`);
    }
}

module.exports = { queryPostgres };

🔧 技術細節

此項目實現了以下功能的模型上下文協議（MCP）服務器：

1. 提供安全、只讀接口訪問 PostgreSQL 數據庫
2. 與 Claude Desktop 通過 MCP 協議集成
3. SQL 查詢驗證，確保僅執行 SELECT 查詢
4. 查詢超時保護（10 秒）

📄 許可證

文檔未提及相關信息，暫不展示。

⚠️ 重要提示

• 確保 PostgreSQL 憑據安全，避免明文存儲
• 配置適當的防火牆規則以限制數據庫訪問
• 定期備份數據庫以防數據丟失
• 啟用 SSL 連接以加密與數據庫的通信