SQL MCP Server

🚀 SQLGenius - スマートSQLアシスタント

SQLGeniusは、自然言語でBigQueryデータベースをクエリするのを支援するスマートSQLアシスタントです。MCP（モデルコンテキストプロトコル）、Vertex AIのGemini Pro、およびStreamlitを基に構築されています。

✨ 主な機能

• Gemini Proを使用して自然言語をSQLに変換する
• 複数のタブを持つインタラクティブなStreamlitインターフェイス
• リアルタイムのクエリ実行と可視化
• データベーススキーマの探索
• クエリ履歴の追跡
• 安全なクエリ検証
• BigQueryとの統合
• MCPアーキテクチャを基礎とする

🎥 デモ

SQLGeniusの実際の動作を見てみましょう！以下は、このアプリケーションの使用方法を簡単にデモするビデオです。

このデモでは、以下のことが確認できます。

1. 自然言語クエリからSQLへの変換
2. インタラクティブなデータ分析の可視化
3. データベーススキーマの探索
4. クエリ履歴の追跡

📦 インストール

1. リポジトリをクローンし、プロジェクトディレクトリに移動します。

cd sql_mcp_server

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

pip install -r requirements.txt

3. .env.exampleファイルを.envにコピーし、設定情報を入力します。

cp .env.example .env

4. .envで環境変数を設定します。

PROJECT_ID=your-project-id
DATASET_ID=your-dataset-id
GOOGLE_APPLICATION_CREDENTIALS=path/to/your/service-account.json
VERTEX_AI_LOCATION=us-central1

💻 使用例

基本的な使用法

1. アプリケーションを起動します。

streamlit run streamlit_app.py

2. Streamlitアプリケーションが起動すると、MCPサーバーが自動的に実行されます。

3. タブを使用して以下の操作を行います。

   • データに関する自然言語の質問をする
   • SQLクエリを直接記述して実行する
   • データベーススキーマを探索する

高度な使用法

📊 インターフェイスタブ

💬 自然言語クエリ

一般的な英語で質問をし、SQLの結果を取得します。

• "Show the top 5 customers by revenue"
• "Which products had the highest sales in January?"
• "How many orders were placed last month?"

📊 SQL クエリ

SQLクエリを直接記述して実行します。

SELECT * FROM orders 
WHERE order_date > '2023-01-01' 
ORDER BY total_amount DESC
LIMIT 10

📋 データベース探索者

• 利用可能なすべてのテーブルを閲覧する
• テーブルのスキーマ情報を表示する
• 任意のテーブルのサンプルデータを表示する

🔧 技術詳細

🔒 セキュリティ機能

• SELECTクエリのみの実行を許可する
• 危険な操作を防止するためのクエリ検証
• 安全な資格情報管理
• エラー処理と入力検証

🛠️ アーキテクチャ

SQLGeniusは、モデルコンテキストプロトコル（MCP）を使用してツールを公開します。これらのツールには以下が含まれます。

1. 自然言語処理：英語の質問をSQLに変換する
2. データ探索：スキーマ情報とサンプルデータを取得する
3. SQL実行：データベース上で検証済みのクエリを実行する

このアーキテクチャは以下の部分で構成されています。

• MCPサーバー：データベース接続を処理し、ツールを提供する
• Streamlitフロントエンドインターフェイス：ユーザーがシステムとやり取りするインターフェイス
• Vertex AI（Gemini Pro）：自然言語理解機能を提供する
• BigQuery：データ上でSQLクエリを実行する

📝 MCP ツール

以下のMCPツールを使用できます。

1. execute_nl_query：自然言語クエリを実行する
2. execute_sql_query：生のSQLクエリを実行する
3. list_tables：利用可能なすべてのテーブルをリストする
4. get_table_schema：特定のテーブルのスキーマを取得する

📚 高度な使用法

MCPサーバーにカスタムツールを追加するには、以下の手順を実行します。

1. sql_mcp_server.pyのregister_tools()メソッドを編集します。
2. @self.tool()デコレータを使用してカスタムツールを追加します。
3. サーバーを再起動します。

🤝 貢献

貢献を歓迎します！自由にプルリクエストを送信してください。