Databricks MCP Server

🚀 Databricks MCP 服務器

Databricks MCP 服務器是一個模型上下文協議（MCP）服務器，它能連接到 Databricks API，讓大語言模型（LLMs）可以運行 SQL 查詢、列出作業並獲取作業狀態，極大地增強了與 Databricks 環境的交互能力。

✨ 主要特性

• 可在 Databricks SQL 倉庫上運行 SQL 查詢。
• 能夠列出所有 Databricks 作業。
• 可以獲取特定 Databricks 作業的狀態。
• 能獲取有關特定 Databricks 作業的詳細信息。

📦 安裝指南

先決條件

• 需要 Python 3.7 及以上版本。
• 帶有以下配置的 Databricks 工作區：
  • 個人訪問令牌
  • SQL 倉庫端點
  • 運行查詢和訪問作業的權限

設置步驟

1. 克隆此存儲庫。
2. 創建並激活虛擬環境（推薦）：

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

3. 安裝依賴項：

   pip install -r requirements.txt
   

4. 在根目錄下創建一個 .env 文件，包含以下變量：

   DATABRICKS_HOST=your-databricks-instance.cloud.databricks.com
   DATABRICKS_TOKEN=your-personal-access-token
   DATABRICKS_HTTP_PATH=/sql/1.0/warehouses/your-warehouse-id
   

5. 測試您的連接（可選但推薦）：

   python test_connection.py
   

獲取 Databricks 憑證

1. 主機：您的 Databricks 實例 URL（例如 your-instance.cloud.databricks.com）。
2. 令牌：在 Databricks 中創建個人訪問令牌：
   • 轉到用戶設置（點擊右上角的用戶名）。
   • 選擇“開發者”選項卡。
   • 在“訪問令牌”下點擊“管理”。
   • 生成新令牌並立即保存。
3. HTTP 路徑：對於您的 SQL 倉庫：
   • 轉到 Databricks 中的 SQL 倉庫。
   • 選擇您的倉庫。
   • 查找連接詳細信息並複製 HTTP 路徑。

💻 使用示例

運行服務器

啟動 MCP 服務器：

python main.py

您可以使用 inspector 測試此 MCP 服務器，運行：

npx @modelcontextprotocol/inspector python3 main.py

可用的 MCP 工具

以下 MCP 工具可供使用：

1. run_sql_query(sql: str) - 在您的 Databricks SQL 倉庫上執行 SQL 查詢。
2. list_jobs() - 列出工作區中的所有 Databricks 作業。
3. get_job_status(job_id: int) - 通過作業 ID 獲取特定 Databricks 作業的狀態。
4. get_job_details(job_id: int) - 獲取特定 Databricks 作業的詳細信息。

與大語言模型結合的示例用法

當與支持 MCP 協議的大語言模型一起使用時，此服務器使您能夠以自然語言與您的 Databricks 環境交互，例如：

• “顯示數據庫中的所有表”
• “運行查詢以查看客戶表中的記錄數”
• “列出我的所有 Databricks 作業”
• “檢查作業 #123 的狀態”
• “顯示作業 #456 的詳細信息”

📚 詳細文檔

故障排除

連接問題

• 確保您的 Databricks 主機正確且不包含 https:// 前綴。
• 檢查您的 SQL 倉庫是否正在運行且可訪問。
• 驗證個人訪問令牌具有必要的權限。
• 運行 included 測試腳本：python test_connection.py

安全注意事項

• 您的 Databricks 個人訪問令牌提供對工作區的直接訪問。
• 確保您的 .env 文件安全且從未提交到版本控制。
• 考慮使用具有適當權限範圍的 Databricks 令牌。
• 在安全的環境中運行此服務器。