Superset MCP

🚀 超集（Superset）プロジェクトドキュメント

このプロジェクトは、Superset インスタンスを管理するための MCP（Manager Control Plane）サーバーです。このサーバーを通じて、ユーザーは Superset 関連のリソースの作成、読み取り、更新、削除などの操作を実行できます。

🚀 クイックスタート

1. 環境変数を設定して、Superset インスタンスの URL と認証情報を指定します。
2. MCP サーバーを起動します。
3. 提供されている API インターフェースを使用して Superset とやり取りします。

✨ 主な機能

• 認証：ユーザー名とパスワードによる認証をサポートします。
• データベース管理：ユーザーがデータベース接続を管理でき、接続テストや関連オブジェクト（グラフやダッシュボード）の取得が可能です。
• SQL ラボ：SQL クエリの実行、クエリのフォーマット、結果のエクスポート機能を提供します。
• データセット管理：データセットの作成と読み取りをサポートします。
• ユーザー情報：現在のユーザーの詳細情報とロールを取得します。

📦 インストール

1. コードリポジトリをクローンします：

   git clone [リポジトリのURL]
   cd superset-mcp
   

2. 依存関係をインストールします：

   pip install -r requirements.txt
   

3. 設定ファイル .env を作成し、以下の内容を含めます：

   SUPERSET_BASE_URL=http://localhost:8088
   SUPERSET_USERNAME=your_username
   SUPERSET_PASSWORD=your_password
   

4. サーバーを起動します：

   python server.py
   

📚 ドキュメント

機能モジュールの詳細説明

認証

• superset_authenticate：ユーザー名とパスワードを使用して認証し、アクセストークンを返します。

データベース管理

• superset_database_list：すべてのデータベースのリストを取得します。
• superset_database_get_by_id：ID を指定して特定のデータベースの詳細情報を取得します。
• superset_database_create：新しいデータベース接続を作成します。
• superset_database_test_connection：データベース接続の有効性をテストします。

SQL ラボ

• superset_sqllab_execute_query：任意の SQL クエリを実行します。
• superset_sqllab_format_sql：SQL コードをフォーマットしてクリーンアップします。
• superset_sqllab_export_query_results：クエリ結果を CSV ファイルとしてエクスポートします。

データセット管理

• superset_dataset_list：利用可能なすべてのデータセットをリスト表示します。
• superset_dataset_get_by_id：ID を指定して特定のデータセットの詳細情報を取得します。
• superset_dataset_create：新しいデータセットを作成します。

環境変数

トラブルシューティング

• 認証問題：.env ファイル内の認証情報が正しいか確認してください。
• 接続問題：Superset インスタンスが実行中で、指定された URL でアクセスできることを確認してください。
• バージョン互換性：テスト済みの Superset バージョン（例：4.1.1）を使用することをおすすめします。

セキュリティに関する注意事項

• ユーザー名とパスワードはローカルの .env ファイルにのみ保存され、サードパーティには送信されません。
• アクセストークンはプロジェクトディレクトリ内の .superset_token ファイルに保存されます。
• すべての認証プロセスは MCP サーバーと Superset インスタンスの間で直接行われます。

コントリビューションガイド

コントリビューションを歓迎します！自由にプルリクエストを送信してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。