MCP Alchemy

🚀 MCP Alchemy 項目文檔

MCP Alchemy 是一款強大的工具，旨在增強 Claude Desktop 與數據庫的交互能力。藉助該工具，Claude 能夠直接訪問和操作各類數據庫，輕鬆獲取相關數據信息。

🚀 快速開始

MCP Alchemy 可助力 Claude Desktop 與數據庫高效交互，讓數據操作更便捷。

📦 安裝指南

1. 克隆倉庫

   git clone git@github.com:runekaagaard/mcp-alchemy.git
   cd mcp-alchemy
   uv sync
   

2. 安裝依賴 按需安裝數據庫驅動：

   uv pip install psycopg2-binary
   

3. 配置Claude Desktop 將以下內容添加到 claude_desktop_config.json 中：

   "command": "uv",
   "args": ["run", "--directory", "/path/to/mcp-alchemy", "-m", "mcp_alchemy.server", "main"],
   

✨ 主要特性

工具（Tools）

• all_table_names
  • 功能：獲取數據庫中所有表的名稱。
  • 輸入：無
  • 輸出：逗號分隔的表名列表。

  users, orders, products, categories
  

• filter_table_names
  • 功能：根據子字符串查找表。
  • 輸入：q（字符串）
  • 輸出：匹配的表名。

  Input: "user"
  Output: "users, user_roles, user_permissions"
  

• schema_definitions
  • 功能：獲取指定表的詳細架構信息。
  • 輸入：table_names（字符串數組）
  • 輸出：包括列名稱、類型、主鍵、外鍵關係和可空標誌等表定義。

  users:
      id: INTEGER, primary key, autoincrement
      email: VARCHAR(255), nullable
      created_at: DATETIME
      
      Relationships:
        id -> orders.user_id
  

• execute_query
  • 功能：執行 SQL 查詢並以垂直格式輸出結果。
  • 輸入：query（字符串）、可選的 params（對象）
  • 輸出：整潔的垂直格式結果，支持大結果集的智能截斷和完整的上下文窗口外數據訪問。

  1. 行
  id: 123
  name: John Doe
  created_at: 2024-03-15T14:30:00
  email: NULL
  
  Result: 1 rows
  

環境變量（Environment Variables）

• DB_URL：SQLAlchemy 數據庫 URL（必填）。
• CLAUDE_LOCAL_FILES_PATH：完整結果集的目錄路徑（可選）。
• EXECUTE_QUERY_MAX_CHARS：最大輸出長度（可選，默認 4000）。

📚 詳細文檔

API 接口

MCP Alchemy 提供了一系列 API 接口，方便開發者調用數據庫功能。主要接口包括：

• 列出所有表名 (all_table_names)
• 過濾表名 (filter_table_names)
• 獲取表架構信息 (schema_definitions)
• 執行查詢 (execute_query)

與Claude Local Files 的集成

當配置了 claude-local-files 後，MCP Alchemy 可以：

• 訪問上下文窗口外的大結果集。
• 生成詳細的報告和可視化圖表。
• 執行深度數據分析。
• 導出結果進行進一步處理。

開發指南

1. 克隆倉庫：git clone git@github.com:runekaagaard/mcp-alchemy.git
2. 安裝依賴：運行 uv sync 和必要的數據庫驅動安裝命令。
3. 配置Claude Desktop：參考上述配置示例，將 MCP Alchemy 集成到 Claude 中。

貢獻指南

歡迎社區貢獻！無論是報告問題、提出新功能、改進文檔還是代碼貢獻，我們都熱烈歡迎：

• 提交問題或功能請求
• 提交 Pull Request 修復 bug 或新增功能
• 增強文檔或分享使用案例
• 在 GitHub 上討論和交流經驗

📄 許可證

項目採用 Mozilla Public License Version 2.0。

👨‍💻 作者的其他LLM 項目

• MCP Redmine：Claude Desktop 管理 Redmine 項目和任務。
• MCP Notmuch Sendmail：Claude Desktop 集成 Notmuch 郵件系統。
• MCP Alchemy：Claude Desktop 數據庫交互工具。

希望以上文檔能幫助您更好地理解和使用 MCP Alchemy 項目！