Superset Mcp Server
What is Superset Mcp Server
superset-mcp-server is a server-side application built on the Apache Superset REST API, designed to implement basic querying capabilities through large models in the Model Context Protocol (MCP).
Use cases
Use cases include integrating with data visualization tools, enabling complex data queries for applications, and providing a backend service for data analysis in various industries.
How to use
To use superset-mcp-server, first install the dependencies using ‘npm install’. Then, you can start the service by running ‘npm start’ after building the project. For testing, you can run example scripts located in the ‘src/examples’ directory.
Key features
Key features include database querying, table querying, field querying, and executing SQL commands.
Where to use
superset-mcp-server can be used in data analytics, business intelligence, and any application requiring advanced data querying capabilities through a RESTful API.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Overview
What is Superset Mcp Server
superset-mcp-server is a server-side application built on the Apache Superset REST API, designed to implement basic querying capabilities through large models in the Model Context Protocol (MCP).
Use cases
Use cases include integrating with data visualization tools, enabling complex data queries for applications, and providing a backend service for data analysis in various industries.
How to use
To use superset-mcp-server, first install the dependencies using ‘npm install’. Then, you can start the service by running ‘npm start’ after building the project. For testing, you can run example scripts located in the ‘src/examples’ directory.
Key features
Key features include database querying, table querying, field querying, and executing SQL commands.
Where to use
superset-mcp-server can be used in data analytics, business intelligence, and any application requiring advanced data querying capabilities through a RESTful API.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Content
WIP: MCP Server Superset
基于 Apache Superset REST API 构建的 Model Context Protocol (MCP) 服务器端应用。
项目简介
这是一个基于 Apache Superset RESTAPI 在MCP上实现了通过大模型来让它进行基本的查询能力。
功能特性
- 查询数据库
- 查询表
- 查询字段
- 执行sql
环境要求
- Node.js >= 14.0.0
快速开始
直接使用
npx -y https://github.com/LiusCraft/superset-mcp-server SUPERSET_URL SUPERSET_USERNAME SUPERSET_PASSWORD 鉴权方式：ladp
安装依赖
# 安装 Node.js 依赖
npm install
启动服务
# api client 测试
npm run src/examples/superset-example.ts
# 调试环境
npm run inspector
# 生产环境
npm run build
npm start
配置说明
项目配置文件位于 config 目录下，包括：
- 数据库配置
- API 配置
- 安全配置
API 文档
参考superset官方 swagger文档
开发指南
目录结构
. ├── src/ # 源代码目录 ├── src/examples # 封装的api客户端测试代码 ├── src/services # 封装的api函数 ├── src/utils # 封装的superset baseHttpClient ├── src/index.ts # 定义mcp接口
开发规范
- 遵循 ESLint 规范
- 使用 TypeScript 进行开发
- 遵循 Git Flow 工作流
部署
mcp 部署
-
build the project
-
set mcp config:
node currentFolder/build/index.js
- use the mcp
贡献指南
- Fork 本仓库
- 创建特性分支
- 提交变更
- 发起 Pull Request
许可证
联系方式
如有问题，请提交 Issue 或联系项目维护者。
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
