Postgresql Alchemy

🚀 使用MCP與您的數據庫對話

本項目可讓您藉助MCP與數據庫進行交互。通過設置MCP服務器，您能使用Claude Desktop與PostgreSQL數據庫實現交互，同時該項目底層使用sqlalchemy，也適用於MySQL、MariaDB、SQLite。本項目基於https://github.com/runekaagaard/mcp-alchemy構建。

🚀 快速開始

✨ 主要特性

• 支持通過Claude Desktop與多種數據庫（如PostgreSQL、MySQL、MariaDB、SQLite）進行交互。
• 基於sqlalchemy實現，具有良好的兼容性。
• 藉助Docker Compose和環境變量配置，方便快捷地搭建服務。

📦 安裝指南

前提條件

• Docker Compose：安裝說明
• Claude Desktop：此處下載
• uv：一個現代、高性能的Python包管理器。如果沒有安裝，請按照以下說明操作。

具體步驟

1. 設置環境變量
   • 複製並重命名環境文件，將提供的.env.example文件複製並命名為.env：

   cp .env.example .env
   

2. 設置Claude Desktop
   • 訪問Claude Desktop下載頁面並安裝該應用程序。
3. 使用Dummy數據啟動PostgreSQL數據庫
   • 確保Docker Compose已安裝並運行，執行以下命令：

   docker-compose up -d
   

   • 此命令將在localhost:5432啟動一個PostgreSQL數據庫，並使用Dummy數據進行填充。
4. 安裝uv（如果沒有安裝）
   • 執行以下命令以安裝uv：

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

5. 配置並啟動MCP服務器
   • 創建/更新MCP服務器配置，將以下JSON配置保存到您的MCP服務器配置文件中（根據需要調整路徑）：

   {
     "mcpServers": {
       "my_database": {
         "command": "uv",
         "args": [
           "--directory",
           "/directory/where/this/app/is/located/app/",
           "run",
           "server.py"
         ],
         "env": {
           "DB_URL": "postgresql://postgres:password@localhost:5432/mydatabase"
         }
       }
     }
   }
   

   • 提示：如果uv安裝在非標準位置，請更新"command"值以反映可執行文件的完整路徑。
   • 配置就緒後，每次啟動Claude Desktop時，MCP服務器都會自動啟動。

💻 使用示例

完成上述安裝和配置步驟後，您就可以開始使用MCP與數據庫進行交互了：

1. 打開Claude Desktop。
2. 工具將自動調用您的MCP服務器，從而讓您無縫地與數據庫交互。

📚 詳細文檔

總結

1. 設置環境變量：複製.env.example到.env。
2. 安裝並運行Claude Desktop：從Claude Desktop下載。
3. 使用Docker Compose啟動PostgreSQL：運行docker-compose up以啟動帶有Dummy數據的數據庫。
4. 安裝uv：運行提供的安裝命令（如果需要）。
5. 配置MCP服務器：更新配置文件，並確保路徑和環境變量正確。
6. 啟動並享受樂趣：啟動Claude Desktop開始通過MCP與您的數據庫交互。

🔧 注意事項

⚠️ 重要提示

本指南假設您對Docker、環境變量和CLI使用有基本的瞭解。

如果您遇到任何問題或需要進一步幫助，請參考相關文檔或聯繫支持團隊。祝您編程愉快！