Liuscraft Superset MCP Server

🚀 WIP: MCP 服务器超集

本项目是基于 Apache_superset REST_API 构建的 Model Context Protocol (MCP) 服务器端应用，借助大模型实现了基本的查询能力，为数据库操作提供了便捷途径。

🚀 快速开始

安装依赖

# 安装 Node.js 依赖
npm install

启动服务

# API client 测试
npm run src/examples/superset-example.ts

# 调试环境
npm run inspector

# 生产环境
npm run build
npm start

✨ 主要特性

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

📦 安装指南

环境要求

• Node.js >= 14.0.0

📚 详细文档

配置说明

项目配置文件位于 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. 构建项目
2. 设置 MCP 配置：

node currentFolder/build/index.js

3. 使用 MCP

贡献指南

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

📄 许可证

Apache License 2.0

💡 使用建议

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