Liuscraft Superset MCP Server

🚀 WIP: MCP サーバースーパーセット

このプロジェクトは、Apache_superset REST_API を基に構築された Model Context Protocol (MCP) のサーバーサイドアプリケーションです。大規模言語モデルを利用して、基本的なクエリ機能を実現しています。

✨ 主な機能

• データベースのクエリ
• テーブルのクエリ
• フィールドのクエリ
• SQL の実行

📦 インストール

環境要件

• Node.js >= 14.0.0

依存関係のインストール

# Node.js の依存関係をインストール
npm install

🚀 クイックスタート

サービスの起動

# API クライアントのテスト
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. プロジェクトをビルドする
2. MCP の設定を行う:

node currentFolder/build/index.js

3. MCP を使用する

🤝 貢献ガイド

1. このリポジトリを Fork する
2. 機能ブランチを作成する
3. 変更をコミットする
4. Pull Request を送信する

📄 ライセンス

Apache License 2.0

📞 連絡先

問題がある場合は、Issue を提出するか、プロジェクトのメンテナに連絡してください。