Databricks Genie MCP

🚀 Databricks Genie API MCP 服務器

本項目實現了一個模型上下文協議（MCP）服務器，它將 Databricks Genie API 封裝為一組工具。這些工具可集成到 IDE 或其他工具中，有效提升用戶體驗。

✨ 主要特性

• 啟動對話：在 Genie 空間中開啟全新對話。
• 創建消息：在已有的對話裡添加新消息。
• 獲取消息：從對話中提取所需消息。
• 獲取消息附件查詢結果：獲取消息附件內 SQL 查詢的結果。
• 執行消息附件查詢：執行消息附件中的 SQL 查詢操作。
• 獲取空間信息：獲取 Genie 空間的相關信息。
• 生成完整查詢結果下載：啟動完整查詢結果的下載流程。
• 輪詢消息直到完成：持續輪詢消息，直至其達到終端狀態。

📦 安裝指南

先決條件

1. 安裝 Python 3.8 或更高版本。
2. 安裝 Databricks CLI：

   pip install databricks-cli
   

3. 配置 Databricks CLI：

   dbfs config set <your-workspace-url> <access-token>
   

設置步驟

1. 克隆倉庫並安裝依賴項：

   git clone https://github.com/your-repository.git
   cd genie_mcp_server
   pip install -r requirements.txt
   

2. 配置環境變量或 .env 文件，設置以下內容：

   DATABRICKS_WORKSPACE_URL=your_workspace_url
   DATABRICKS_TOKEN=your_access_token
   

3. 啟動服務器：

   python server.py
   

💻 使用示例

與 Claude Desktop 的集成

在 claude_desktop_config.json 中配置 MCP 服務器：

{
  "mcpServers": {
    "databricks-genie": {
      "type": "stdio",
      "command": "/path/to/python",
      "args": ["server.py"],
      "env": {
        "DATABRICKS_WORKSPACE_URL": "your_workspace_url",
        "DATABRICKS_TOKEN": "your_access_token"
      }
    }
  }
}

工具列表

• start_conversation（啟動對話）：在 Genie 空間中創建新對話。
• create_message（創建消息）：向現有對話添加新內容。
• get_message（獲取消息）：檢索特定消息的詳細信息。
• get_message_attachment_query_result（獲取消息附件查詢結果）：從消息附件獲取 SQL 查詢結果。
• execute_message_attachment_query（執行消息附件查詢）：在 Genie 空間中執行 SQL 代碼片段。
• get_space（獲取空間信息）：獲取指定空間的詳細信息。
• generate_download_full_query_result（生成完整查詢結果下載）：啟動完整查詢結果的下載流程。
• poll_message_until_complete（輪詢消息直到完成）：持續檢查消息狀態，直至其處於完成或失敗狀態。

📚 詳細文檔

故障排除

• 身份驗證問題：檢查 .env 文件中的 Databricks 憑證是否正確，並確保用戶具有適當的權限。
• 連接問題（Claude Desktop）：
  • 確保 claude_desktop_config.json 中的路徑完全正確。
  • 驗證 Python 解釋器路徑是否存在且可執行。
  • 查看日誌文件，如 ~/Library/Logs/Claude/ 或 %APPDATA%\Claude\logs，特別是 mcp.log 和 mcp-server-databricks-genie.log。
• SQL 執行錯誤：確認服務主體或用戶對 SQL 倉庫具有執行權限，並且能夠訪問相關的 Unity Catalog 數據。

安全注意事項

• 憑據管理：絕不對硬編碼憑據。使用環境變量（.env 文件）或安全的憑證存儲。確保 .env 文件不在版本控制系統中提交。
• MCP 安全性：此服務器在本地運行，使用用戶的權限和 Databricks 憑證。客戶端如 Claude Desktop 必須先獲得用戶同意才能執行工具（參考 MCP 安全規範）。
• 生產環境部署：不要直接暴露此本地服務器用於更廣泛的用途。與安全團隊合作，確定適當的主機設置、網絡控制以及可能的 MCP 服務器級身份驗證機制。

🤝 貢獻

歡迎貢獻！請通過提交問題或拉取請求參與項目。

📄 許可證

該軟件由 Databricks, Inc. 授予特定許可。請查看 LICENSE 文件以獲取完整使用條款。