SQL MCP - SQL Server for Model Context Protocol

这是一个针对SQL Server查询的Model Context Protocol (MCP)服务器实现，它通过GitHub Copilot实现了与数据库的自然语言交互。

概述

SQL MCP允许您通过GitHub Copilot使用自然语言查询SQL Server数据库。这种集成使得数据库交互更加便捷，无需深入了解SQL知识。

关键特性：

• 使用自然语言查询SQL Server数据库
• 集成GitHub Copilot
• 返回JSON格式的数据
• 支持Azure SQL Database

先决条件

• .NET 9.0 SDK或更高版本
• Visual Studio 2022或Visual Studio Code
• GitHub Copilot（代理模式）
• 访问SQL Server或Azure SQL Database

安装指南

1. 克隆仓库

   git clone https://github.com/ustabar/sql-mcp.git
   cd sql-mcp
   

2. 配置数据库连接

   编辑appsettings.json文件以更新您的数据库连接字符串：

   {
     "ConnectionStrings": {
       "AzureSqlConnection": "Server=yourserver.database.windows.net,1433;Database=yourdatabase;User Id=yourusername;Password=yourpassword;TrustServerCertificate=True;"
     }
   }
   

3. 构建并运行应用程序

   dotnet build
   dotnet run
   

4. 在VS Code中配置MCP

   将MCP服务器添加到您的VS Code设置中：

   

   示例设置条目：

   "github.copilot.advanced": {
     "mcp": {
       "enabled": true,
       "mcp_server_command": "dotnet run --project C:\\path\\to\\sql-mcp"
     }
   }
   

5. 验证MCP服务器是否正在运行

   您可以在VS Code中检查可用的MCP服务器：

   

使用方法

一旦安装完成，您可以通过GitHub Copilot代理模式使用自然语言查询数据库：

MCP服务器处理您的自然语言查询，将其转换为SQL，并以结构化格式返回结果。

示例交互：

结构

• Program.cs：应用程序入口点和MCP服务器配置
• Services/SqlConnectionService.cs：管理数据库连接
• Tools/SqlServerTools.cs：实现用于SQL交互的MCP工具
• Data/prompt-tr.txt：包含土耳其语支持的提示模板

贡献

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

许可证

本项目采用MIT许可证——详情见LICENSE文件。