Postgres Query

🚀 MCP PostgreSQL 查詢服務器

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

🚀 快速開始

本項目實現了一個具備特定功能的模型上下文協議（MCP）服務器，可安全地以只讀模式訪問 PostgreSQL 數據庫，並與 Claude Desktop 集成。

✨ 主要特性

• 安全的只讀接口：提供安全的只讀接口訪問 PostgreSQL 數據庫，僅允許執行 SELECT 查詢，確保數據庫安全。
• 與 Claude Desktop 集成：通過 MCP 協議與 Claude Desktop 集成，方便使用。
• SQL 查詢驗證：對 SQL 查詢進行驗證，確保僅執行 SELECT 查詢，防止潛在的有害 SQL 操作。
• 查詢超時保護：設置了 10 秒的查詢超時保護，避免長時間運行的查詢佔用資源。
• JSON 響應格式化：查詢結果以結構化的 JSON 格式返回，便於處理和解析。

📦 安裝指南

先決條件

• 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 服務器：

{
    "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 重建

API 使用示例

工具

query-postgres

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

參數：

• query (string)：要執行的 SELECT SQL 查詢

響應：

• 包含以下內容的 JSON 對象：
  • rows：結果集行
  • rowCount：返回的行數
  • columns：查詢的結果列

示例

{
  "query": "SELECT * FROM users LIMIT 5",
  "result": {
    "rows": [
      { "id": 1, "name": "Alice" },
      { "id": 2, "name": "Bob" }
    ],
    "rowCount": 2,
    "columns": ["id", "name"]
  }
}

📚 詳細文檔

項目結構

• src/：包含核心的服務器實現
• dist/：構建輸出目錄
• package.json：項目依賴和腳本
• README.md：項目文檔

貢獻指南

• 提交代碼前，請確保通過 npm 腳本運行測試。
• 遵循項目的代碼規範。

🔧 技術細節

該項目實現了一個模型上下文協議（MCP）服務器，通過 Node.js 與 PostgreSQL 數據庫進行交互。服務器提供了安全的只讀接口，對 SQL 查詢進行驗證，確保僅執行 SELECT 查詢，並設置了 10 秒的查詢超時保護。通過 MCP 協議與 Claude Desktop 集成，查詢結果以結構化的 JSON 格式返回。

📄 許可證

文檔未提及許可證信息。

🔒 安全考慮

⚠️ 重要提示

• 確保數據庫憑據的安全性，避免在代碼中明文存儲。
• 使用環境變量或配置管理工具來管理敏感信息。
• 定期審計和更新服務器安全策略。