Superset MCP

🚀 超集（Superset）項目文檔

這是一個用於管理 Superset 實例的 MCP（Manager Control Plane）服務器。藉助該服務器，用戶能夠開展各類操作，涵蓋創建、讀取、更新和刪除與 Superset 相關的資源，為 Superset 的管理提供了便捷高效的途徑。

🚀 快速開始

1. 配置環境變量，指定 Superset 實例的 URL 和憑據。
2. 啟動 MCP 服務器。
3. 使用提供的 API 接口與 Superset 進行交互。

✨ 主要特性

• 身份驗證：支持基於用戶名和密碼的身份驗證。
• 數據庫管理：允許用戶管理數據庫連接，包括測試連接和獲取相關對象（如圖表和儀表板）。
• SQL 實驗室：提供執行 SQL 查詢、格式化查詢以及導出結果的功能。
• 數據集管理：支持創建和讀取數據集。
• 用戶信息：獲取當前用戶的詳細信息及其角色。

📦 安裝指南

1. 克隆代碼倉庫：

   git clone [倉庫地址]
   cd superset-mcp
   

2. 安裝依賴項：

   pip install -r requirements.txt
   

3. 創建配置文件 .env，包含以下內容：

   SUPERSET_BASE_URL=http://localhost:8088
   SUPERSET_USERNAME=your_username
   SUPERSET_PASSWORD=your_password
   

4. 啟動服務器：

   python server.py
   

📚 詳細文檔

功能模塊詳細說明

身份驗證

• superset_authenticate：使用用戶名和密碼進行身份驗證，返回訪問令牌。

數據庫管理

• superset_database_list：獲取所有數據庫的列表。
• superset_database_get_by_id：通過 ID 獲取特定數據庫的詳細信息。
• superset_database_create：創建新的數據庫連接。
• superset_database_test_connection：測試數據庫連接的有效性。

SQL 實驗室

• superset_sqllab_execute_query：執行任意 SQL 查詢。
• superset_sqllab_format_sql：格式化和清理 SQL 代碼。
• superset_sqllab_export_query_results：將查詢結果導出為 CSV 文件。

數據集管理

• superset_dataset_list：列出所有可用數據集。
• superset_dataset_get_by_id：通過 ID 獲取特定數據集的詳細信息。
• superset_dataset_create：創建新的數據集。

環境變量

🔧 技術細節

故障排除

• 認證問題：檢查 .env 文件中的憑據是否正確。
• 連接問題：確保 Superset 實例正在運行並且可以通過指定 URL 訪問。
• 版本兼容性：建議使用經過測試的 Superset 版本（如 4.1.1）。

安全注意事項

• 用戶名和密碼僅存儲在本地 .env 文件中，不會傳輸到第三方。
• 訪問令牌存儲在項目目錄中的 .superset_token 文件中。
• 所有認證過程直接發生在 MCP 服務器和 Superset 實例之間。

🤝 貢獻指南

歡迎貢獻！請隨意提交拉取請求。

📄 許可證

本項目採用 MIT 許可證。