SQLGenius - AI 驱动的 SQL 助手

SQLGenius 是一款智能 SQL 助手，可帮助您使用自然语言查询 BigQuery 数据库。它基于 MCP（模型上下文协议）、Vertex AI 的 Gemini Pro 和 Streamlit 构建。

🌟 功能

• 使用 Gemini Pro 将自然语言转换为 SQL
• 具有多个选项卡的交互式 Streamlit UI
• 实时查询执行和可视化
• 数据库模式浏览器
• 查询历史记录跟踪
• 安全查询验证
• 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 结果：

• "按收入显示前 5 名客户"
• "哪些产品在 1 月份的销量最高？"
• "上个月下了多少订单？"

📊 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. 重新启动服务器

🤝 贡献

欢迎贡献！请随时提交 Pull Request。