mcpField
W
WIP: MCP Server Superset

WIP: MCP Server Superset

Local
github.com/LiusCraftData & Analytics5Updated 81w ago
Repository

About WIP: MCP Server Superset

WIP: MCP Server Superset is an MCP server built on the Apache Superset REST API, for users querying Superset data through an LLM. It supports database, table, and field queries, as well as SQL execution.

Key features

  1. 01Query databases
  2. 02Query tables
  3. 03Query fields
  4. 04Execute SQL

Use cases

  1. 01Inspect databases in Superset
  2. 02Find table and field information
  3. 03Query data with SQL

MCP support

The MCP server exposes Apache Superset REST API capabilities for database, table, and field queries, as well as SQL execution, to MCP clients.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
  "mcpServers": {
    "superset": {
      "command": "npx",
      "args": [
        "-y",
        "https://github.com/LiusCraft/superset-mcp-server"
      ]
    }
  }
}
Run commandnpx -y https://github.com/LiusCraft/superset-mcp-server

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npmsuperset-mcp-server

Tools

No tool list yet

Local servers expose tools only once running on your machine, and the maintainer has not provided a tool list.

Details

From the project README

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 部署

  1. build the project

  2. set mcp config:

node currentFolder/build/index.js
  1. use the mcp

贡献指南

  1. Fork 本仓库
  2. 创建特性分支
  3. 提交变更
  4. 发起 Pull Request

许可证

Apache License 2.0

联系方式

如有问题，请提交 Issue 或联系项目维护者。

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.