SQL MCP Server

🚀 SQLGenius - 智能SQL助手

SQLGenius是一款強大的智能SQL助手，它能讓您通過自然語言對BigQuery數據庫進行查詢操作。該項目基於MCP（模型上下文協議）、Vertex AI的Gemini Pro以及Streamlit構建，為用戶提供了便捷高效的數據庫查詢體驗。

🚀 快速開始

SQLGenius能幫助您輕鬆使用自然語言查詢BigQuery數據庫。以下是快速上手的步驟：

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

5. 啟動應用程序：

streamlit run streamlit_app.py

6. 當Streamlit應用程序啟動時，MCP服務器會自動運行。之後您就可以使用標籤頁進行自然語言提問、編寫和執行SQL查詢、探索數據庫架構等操作。

✨ 主要特性

• 智能轉換：藉助Gemini Pro將自然語言精準轉換為SQL。
• 交互式界面：擁有多個標籤頁的交互式Streamlit界面，操作便捷。
• 即時反饋：支持即時查詢執行和可視化，讓您及時獲取結果。
• 架構探索：可對數據庫架構進行探索，深入瞭解數據結構。
• 歷史跟蹤：能跟蹤查詢歷史記錄，方便回顧和複用。
• 安全驗證：具備安全查詢驗證機制，保障數據安全。
• 深度集成：與BigQuery深度集成，高效處理數據。
• 先進架構：基於MCP架構構建，穩定可靠。

🎥 演示

觀看SQLGenius的實際操作！以下是一個快速演示如何使用該應用程序的視頻：

在本演示中，您可以看到：

1. 自然語言查詢到SQL的轉換過程。
2. 交互式數據分析可視化效果。
3. 數據庫架構探索的操作方式。
4. 查詢歷史記錄跟蹤的功能展示。

💻 使用示例

基礎用法

💬 自然語言查詢

用普通英語提問並獲得SQL結果：

• "顯示收入前5名的客戶"
• "一月份銷售最高的產品有哪些？"
• "上個月下了多少訂單？"

📊 SQL 查詢

直接編寫和執行SQL查詢：

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

📋 數據庫探索者

• 瀏覽所有可用的表。
• 查看錶架構信息。
• 查看任何表的樣例數據。

高級用法

要在MCP服務器上添加自定義工具：

1. 編輯sql_mcp_server.py中的register_tools()方法。
2. 使用@self.tool()裝飾器添加您的自定義工具。
3. 重啟服務器。

🔧 技術細節

架構概述

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：獲取特定表的架構。

🔒 安全特性

• 查詢限制：只允許執行SELECT查詢，防止數據被惡意修改。
• 驗證機制：進行查詢驗證以防止危險操作。
• 憑證管理：採用安全憑證管理，保障數據訪問安全。
• 輸入驗證：具備錯誤處理和輸入驗證功能，確保系統穩定運行。

🤝 貢獻

歡迎貢獻！請隨意提交拉取請求。