SQL MCP - SQL Server for Model Context Protocol

SQL MCP - SQL Server for Model Context Protocol

site icon
2025.04.04 1
C#SQL Server 查询自然语言交互GitHub Copilot 集成数据库开发效率
SQL MCP 是一个基于 Model Context Protocol (MCP) 的 SQL Server 查询服务,通过 GitHub Copilot 实现自然语言与数据库的交互。它使得用户无需深入了解 SQL 语法即可轻松查询数据库,适用于开发者和数据分析师。
View on GitHub

Overview

基本能力

产品定位

SQL MCP 是一个用于 SQL Server 查询的 MCP 服务器实现,通过 GitHub Copilot 实现自然语言与数据库的交互。

核心功能

  • 通过自然语言查询 SQL Server 数据库
  • 与 GitHub Copilot 集成
  • 返回 JSON 格式的响应
  • 支持 Azure SQL Database

适用场景

  • 开发者快速查询数据库
  • 数据分析师进行数据探索
  • 团队协作中简化数据库交互

工具列表

  • SqlServerTools.cs: 实现 SQL 交互的 MCP 工具
  • SqlConnectionService.cs: 管理数据库连接

常见问题解答

  • 如何配置数据库连接? 编辑 appsettings.json 文件中的 ConnectionStrings 部分。
  • 如何验证 MCP 服务器是否运行? 在 VS Code 中检查可用的 MCP 服务器列表。

使用教程

使用依赖

  • .NET 9.0 SDK 或更高版本
  • Visual Studio 2022 或 Visual Studio Code
  • GitHub Copilot with Agent Mode
  • SQL Server 或 Azure SQL Database 访问权限

安装教程

  1. 克隆仓库 bash git clone https://github.com/ustabar/sql-mcp.git cd sql-mcp

  2. 配置数据库连接 编辑 appsettings.json 文件,更新数据库连接字符串。

  3. 构建并运行应用 bash dotnet build dotnet run

  4. 配置 VS Code 以使用 MCP 在 VS Code 设置中添加 MCP 服务器配置。

调试方式

  • 检查 VS Code 中的 MCP 服务器列表以确认服务器是否运行。
  • 通过 GitHub Copilot Agent Mode 进行自然语言查询测试。

许可证

该项目遵循 MIT 开源许可条款。