WIP: MCP Server Superset

WIP: MCP Server Superset

site icon
2025.04.04 1
TypeScript数据库管理数据分析开发工具数据库开发效率
LiusCraft_superset-mcp-server 是一个基于 Apache Superset REST API 构建的 Model Context Protocol (MCP) 服务器端应用。它通过大模型实现了基本的数据库查询能力,包括查询数据库、查询表、查询字段以及执行 SQL 语句。
View on GitHub

Overview

基本能力

产品定位

LiusCraft_superset-mcp-server 是一个基于 Apache Superset REST API 的 MCP 服务器端应用,旨在通过大模型提供数据库查询功能。

核心功能

  • 查询数据库
  • 查询表
  • 查询字段
  • 执行 SQL

适用场景

  • 数据库管理与查询
  • 数据分析与可视化
  • 开发环境中的数据库调试

工具列表

  • npm run src/examples/superset-example.ts:API 客户端测试工具
  • npm run inspector:调试环境工具
  • npm run buildnpm start:生产环境部署工具

常见问题解答

  • 如何启动服务?参考快速开始部分的命令。
  • 如何配置项目?参考配置说明部分的描述。
  • 如何贡献代码?参考贡献指南部分的步骤。

使用教程

使用依赖

  • Node.js >= 14.0.0

安装 Node.js 依赖:

npm install

安装教程

  1. 安装依赖:
npm install
  1. 启动服务:
npm run src/examples/superset-example.ts
  1. 调试环境:
npm run inspector
  1. 生产环境:
npm run build
npm start

调试方式

  1. 启动调试环境:
npm run inspector
  1. 测试 API 客户端:
npm run src/examples/superset-example.ts

许可证

该项目遵循 Apache License 2.0 开源许可条款。