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 或聯繫項目維護者。