🚀 SQL Server 自然语言查询工具使用文档
本工具基于自然语言处理技术，旨在简化 SQL Server 数据库的操作。用户只需通过中文提问，工具就能自动生成并执行相应的 SQL 查询，极大提升了数据库操作的便捷性。
🚀 快速开始
本项目基于微软的 Modal Context Protocol (MCP)，由 Aman Pachori 初始实现。如果你想使用该工具，可按以下步骤进行安装与配置。
📦 安装指南
环境要求
- 操作系统：Windows 10 或更高版本
- .NET Framework：版本 4.7.2 或更高
- ODBC 驱动：必须安装 Microsoft ODBC Driver for SQL Server
配置步骤
- 下载并安装 Microsoft ODBC Driver for SQL Server。
- 创建配置文件
config.json，填写以下信息：{ "Server": "你的服务器地址", "Database": "你的数据库名称", "UID": "你的登录名", "PWD": "你的密码" } - 将
config.json放置在工具的根目录下。
✨ 主要特性
核心功能
- 自然语言查询：用户可通过中文提问，工具自动生成 SQL 查询。
- 结果解释：工具将提供结果的中文解释，帮助用户理解数据。
- 查询历史：记录所有执行过的查询，便于追溯和管理。
特殊命令
/diagnose：执行全面的表访问诊断/refresh_schema：刷新表结构信息/history：查看当前会话中的所有查询记录
💻 使用示例
基础用法
> 显示所有薪资超过50000的员工信息。
SQL 查询生成: SELECT EmployeeName, Department, Salary FROM dbo.Employees WHERE Salary > 50000 ORDER BY Salary DESC;
执行成功，结果如下：
+----------------+-------------+------+
| 员工姓名 | 部门 | 工资 |
|----------------+------------+------|
| 张三 | 技术部 | 60000 |
| 李四 | 人力资源部 | 55000 |
| 王五 | 市场部 | 70000 |
+----------------+-------------+------+
结果解释：以下是薪资超过50000的所有员工，按工资降序排列。王五是薪资最高的员工，达到70000元。
高级用法
> 显示每个部门的最高薪资。
SQL 查询生成: SELECT Department, MAX(Salary) AS MaxSalary FROM dbo.Employees GROUP BY Department;
执行成功，结果如下：
+------------+-----------+
| 部门 | 最高薪资 |
|------------+-----------|
| 技术部 | 80000 |
| 人力资源部 | 65000 |
| 市场部 | 75000 |
+------------+-----------+
结果解释：技术部的最高薪资为80000元，由张三获得；市场部的最高薪资为75000元，由王五获得。
📚 详细文档
安全注意事项
- 单表访问：查询严格限制在配置的表内进行。
- 查询验证：所有 SQL 查询将在执行前展示给用户，确保操作安全。
- 事务安全性：更新、插入和删除操作使用带有回滚的事务，保障数据完整性。
- 错误日志：详细记录错误信息，便于排查问题而不泄露敏感信息。
- 防止 SQL 注入：结构化的查询生成机制降低了 SQL 注射的风险。
日志与记录
所有查询及其结果均自动保存至 logs/queries/ 文件夹中，每个日志文件包含：
- 原始自然语言查询
- 所有 SQL 迭代版本及反馈
- 最终执行的 SQL 查询
- 查询结果
- 时间戳
故障排除
连接问题
- 确认服务器地址或 IP 正确。
- 检查 SQL Server 是否运行且允许远程连接。
- 查看防火墙设置，确保 SQL 服务器端口开放。
- 验证 ODBC 驱动是否正确安装并配置。
记忆限制问题
- 等待重试：大多情况等待一段时间后重试即可解决。