使用说明
项目简介
本Superset MCP集成项目是一个基于Model Context Protocol (MCP) 的服务器实现,旨在让AI智能体(如Claude)能够通过自然语言指令与Apache Superset数据可视化平台进行交互。它提供了一系列工具,允许AI智能体查询数据、创建和管理仪表盘、图表等Superset资源,从而实现数据分析和可视化的自动化。
主要功能点
- 连接和认证Superset: 支持连接到本地或远程Superset实例,并进行用户身份验证和Token管理。
- 仪表盘管理: 允许AI智能体列出、查看、创建、更新和删除Superset仪表盘。
- 图表管理: 允许AI智能体列出、查看、创建、更新和删除Superset图表。
- 数据库和数据集操作: 支持数据库连接管理、数据集创建和查询,以及SQL查询执行等功能。
- SQL Lab功能: 提供SQL查询执行、格式化、成本估算和结果获取等SQL Lab的核心功能。
- 用户和系统信息查询: 允许AI智能体获取当前用户信息、角色、最近活动以及Superset的基本配置信息。
- 标签管理: 支持Superset标签的创建、删除和对象标签的添加/移除。
安装步骤
-
安装并运行Superset: 按照仓库 'README.md' 提供的指引,使用Docker Compose在本地安装并运行Apache Superset。确保Superset实例可以通过 'http://localhost:8088' 访问,并记录管理员用户名和密码(默认为 admin/admin)。
-
克隆仓库: 将 'superset-mcp' 仓库克隆到本地计算机。
-
配置环境变量: 在克隆仓库的根目录下创建 '.env' 文件,并根据你的Superset实例配置以下环境变量:
SUPERSET_BASE_URL=http://localhost:8088 # 替换为你的Superset URL SUPERSET_USERNAME=你的Superset用户名 SUPERSET_PASSWORD=你的Superset密码 -
安装依赖: 在仓库根目录下运行命令安装项目依赖:
uv pip install . -
安装MCP配置: 为了让MCP客户端(如Claude)能够识别和连接到此服务器,运行以下命令安装MCP配置文件:
mcp install main.py
服务器配置
为了让MCP客户端连接到此Superset MCP服务器,您需要配置客户端的服务器连接信息。以下是一个JSON格式的配置示例,您需要将其添加到MCP客户端的服务器配置中。
{ "serverName": "superset", "command": "python", "args": ["main.py"] }
- 'serverName': 服务器名称,此处为 'superset',与 'FastMCP("superset", ...)' 中的名称保持一致。
- 'command': 启动服务器的命令,通常为 'python'。
- 'args': 启动命令的参数,此处为 '["main.py"]',指向服务器主程序文件。
基本使用方法
完成安装和配置后,您可以使用支持MCP协议的客户端(例如Claude)与Superset MCP服务器进行交互。通过自然语言指令,您可以指示AI智能体执行各种Superset操作,例如:
- 查询仪表盘列表: "Show me all my Superset dashboards"
- 查看图表详情: "Show me the details of chart with ID 10"
- 执行SQL查询: "Run this SQL query: SELECT COUNT(*) FROM orders"
- 创建新的仪表盘: "Create a new dashboard titled 'Sales Overview'"
请参考仓库 'README.md' 中 "Usage with Claude" 和 "Available MCP Tools" 部分,了解更多可用的自然语言指令和工具。
信息
分类
商业系统