Apache Superset MCP接入與使用操作方法

更新時間：2025年08月28日 11:17:57 作者：奔跑草

Apache Superset MCP 集成（superset-mcp）是一個基于 Model Control Protocol（MCP）的服務器工具,旨在實現(xiàn) AI 代理與 Apache Superset 的程序化交互,本文給大家介紹Apache Superset MCP接入與使用,感興趣的朋友一起看看吧

1. 概述

Apache Superset MCP 集成（superset-mcp）是一個基于 Model Control Protocol（MCP）的服務器工具，旨在實現(xiàn) AI 代理與 Apache Superset 的程序化交互。該項目通過提供標準化的工具接口，使 AI 助手（如 Claude）能夠連接并控制 Superset 實例，實現(xiàn)數據可視化、報表生成、SQL 查詢等操作的自動化。

項目倉庫：https://github.com/aptro/superset-mcp

2. 核心功能與架構

2.1 核心定位

superset-mcp 作為 Superset 與 AI 代理之間的中間層，主要解決以下問題：

提供標準化接口，使 AI 代理能夠理解和操作 Superset
處理認證與權限管理
封裝 Superset API 為更適合 AI 調用的工具集
實現(xiàn)令牌自動刷新與會話管理

2.2 技術架構

基礎框架：基于 FastAPI 構建的 MCP 服務器
通信層：使用 httpx 處理與 Superset 的 HTTP 通信
認證機制：基于令牌的認證系統(tǒng)，支持自動刷新
工具抽象：將 Superset 功能封裝為可調用的 MCP 工具
配置管理：通過環(huán)境變量和 .env 文件管理連接參數

3. 安裝與配置

3.1 安裝方式

方式 1：通過 Smithery 安裝（推薦用于 Claude 桌面端）

npx -y @smithery/cli install @aptro/superset-mcp --client claude

方式 2：手動安裝

# 克隆倉庫
git clone https://github.com/aptro/superset-mcp.git
cd superset-mcp
# 安裝依賴
uv pip install .

3.2 環(huán)境配置

創(chuàng)建 .env 文件配置 Superset 連接信息：

SUPERSET_BASE_URL=http://localhost:8088  # Superset 實例地址
SUPERSET_USERNAME=admin                  # Superset 用戶名
SUPERSET_PASSWORD=admin                  # Superset 密碼

3.3 啟動 Superset 實例

推薦使用 4.1.1 版本（經測試兼容）：

git clone --branch 4.1.1 --depth 1 https://github.com/apache/superset && \
cd superset && \
docker compose -f docker-compose-image-tag.yml up

4. 核心工具集

superset-mcp 提供了豐富的 MCP 工具，覆蓋 Superset 主要功能領域，以下是分類說明：

4.1 認證相關工具

superset_auth_check_token_validity - 驗證當前訪問令牌有效性
superset_auth_refresh_token - 刷新訪問令牌
superset_auth_authenticate_user - 用戶認證

4.2 儀表盤操作

superset_dashboard_list - 列出所有儀表盤
superset_dashboard_get_by_id - 獲取特定儀表盤詳情
superset_dashboard_create - 創(chuàng)建新儀表盤
superset_dashboard_update - 更新現(xiàn)有儀表盤
superset_dashboard_delete - 刪除儀表盤

4.3 圖表管理

superset_chart_list - 列出所有圖表
superset_chart_get_by_id - 獲取特定圖表詳情
superset_chart_create - 創(chuàng)建新圖表
superset_chart_update - 更新現(xiàn)有圖表
superset_chart_delete - 刪除圖表

4.4 數據庫與數據集

superset_database_list - 列出所有數據庫連接
superset_database_get_tables - 獲取數據庫中的表
superset_dataset_list - 列出所有數據集
superset_dataset_create - 創(chuàng)建新數據集

4.5 SQL 實驗室功能

superset_sqllab_execute_query - 執(zhí)行 SQL 查詢
superset_sqllab_format_sql - 格式化 SQL 語句
superset_sqllab_get_results - 獲取查詢結果
superset_sqllab_estimate_query_cost - 估算查詢成本
superset_sqllab_export_query_results - 導出查詢結果為 CSV

4.6 其他工具

探索工具（superset_explore_*）- 圖表探索與 permalink 管理
標簽管理（superset_tag_*）- 標簽的創(chuàng)建、刪除與關聯(lián)
用戶信息（superset_user_*）- 獲取當前用戶信息與角色
系統(tǒng)信息（superset_menu_get, superset_config_get_base_url）

5. 使用示例

5.1 基礎使用流程

from mcp.server.fastmcp import Context
from superset_mcp.main import mcp, superset_dashboard_list, superset_sqllab_execute_query
# 初始化上下文（實際使用中由 MCP 服務器管理）
class MockContext:
    def __init__(self, lifespan_context):
        self.request_context = type('', (), {'lifespan_context': lifespan_context})()
# 列出所有儀表盤
async def list_dashboards(ctx: Context):
    result = await superset_dashboard_list(ctx)
    print("所有儀表盤：", result)
# 執(zhí)行 SQL 查詢
async def run_sql_query(ctx: Context, database_id: int, sql: str):
    result = await superset_sqllab_execute_query(
        ctx,
        database_id=database_id,
        sql=sql
    )
    print("查詢結果：", result)
# 運行示例（需在異步環(huán)境中執(zhí)行）
if __name__ == "__main__":
    import asyncio
    asyncio.run(list_dashboards(MockContext(mcp.lifespan_context)))
    asyncio.run(run_sql_query(MockContext(mcp.lifespan_context), 1, "SELECT * FROM users LIMIT 10"))