Postgresql Explorer

🚀 PostgreSQL MCP 服務器

PostgreSQL MCP 服務器使用 Model Context Protocol (MCP) Python SDK 實現。MCP 作為一個開放協議，能讓 LLM 應用程序與外部數據源實現無縫集成。該服務器允許 AI 代理通過標準化接口與 PostgreSQL 數據庫進行交互，為數據交互提供了便利。

🚀 快速開始

使用此 PostgreSQL MCP 服務器，可讓 AI 代理通過標準化接口與 PostgreSQL 數據庫交互。你可以按照以下步驟進行操作：

1. 滿足先決條件，確保有 Python 3.x、PostgreSQL 數據庫服務器以及訪問數據庫的權限。
2. 選擇合適的安裝方式進行安裝。
3. 按照使用方法啟動服務器並使用相關工具進行操作。

✨ 主要特性

• 🔍 列出數據庫架構
• 📋 在架構中列出表
• 📊 描述表結構
• 🔗 列出表的約束和關係
• 🔑 獲取外鍵信息
• 📝 執行 SQL 查詢

📦 安裝指南

使用 Smithery 自動安裝

通過 Smithery 可自動安裝 PostgreSQL MCP Server for Claude Desktop：

npx -y @smithery/cli install @gldc/mcp-postgres --client claude

手動安裝

1. 克隆此倉庫：

git clone <repository-url>
cd mcp-postgres

2. 創建並激活虛擬環境（推薦）：

python -m venv venv
source venv/bin/activate  # 在 Windows 上使用：venv\Scripts\activate

3. 安裝依賴項：

pip install -r requirements.txt

💻 使用示例

基礎用法

1. 提供 PostgreSQL 連接字符串啟動 MCP 服務器：

python postgres_server.py "postgresql://username:password@host:port/database"

2. 該服務器提供以下工具：

• query：執行 SQL 查詢
• list_schemas：列出所有可用的架構
• list_tables：在特定架構中列出所有表
• describe_table：獲取表結構的詳細信息
• get_foreign_keys：獲取表的外鍵關係
• find_relationships：發現表的顯式和隱含關係

高級用法

與 mcp.json 配置

要將此服務器集成到 MCP 兼容工具（如 Cursor）中，請將其添加到您的 ~/.cursor/mcp.json：

{
  "servers": {
    "postgres": {
      "command": "/path/to/venv/bin/python",
      "args": [
        "/path/to/postgres_server.py",
        "postgresql://username:password@host:5432/database?ssl=true"
      ]
    }
  }
}

替換：

• /path/to/venv 為您的虛擬環境路徑
• /path/to/postgres_server.py 為服務器腳本的絕對路徑
• 連接字符串為您的 PostgreSQL 數據庫憑證

⚠️ 重要提示

確保 mcp.json 文件的安全性，因為它包含敏感的數據庫憑據。

📚 詳細文檔

先決條件

• Python 3.x
• PostgreSQL 數據庫服務器
• 訪問 PostgreSQL 數據庫的權限

安全提示

• 絕對不要在代碼中暴露敏感的數據庫憑據
• 使用環境變量或安全配置文件存儲連接字符串
• 考慮使用連接池以提高資源管理效率
• 實施適當的訪問控制和身份驗證

貢獻

歡迎貢獻！請參考項目倉庫瞭解如何參與。

相關項目

• MCP 協議
• PostgreSQL 官方文檔

📄 許可證

版權 © 2023 您的姓名。保留所有權利。

根據以下許可協議授權：

[TO BE ADDED]