返回 MCP 目录
public公开dns本地运行

MCP-SqlServer

一个用于LLM与SQL Server集成的MCP服务器实现,提供数据库连接检查、表结构查询和SQL执行功能

article

README

🚀 MCP-SqlServer

MCP-SqlServer 是一个使用 C# 实现的 MCP 服务器(STDIO)项目。它主要用于与大型语言模型(LLM)集成,并且已在 Microsoft SQL Server 上完成测试,搭配 Claude Desktop 使用。该服务器会将日志记录到 mcp_server.log 文件中。

注意:LLM 可能会修改您的数据库

🚀 快速开始

✨ 主要特性

  • HealthCheck:用于测试与 Microsoft SQL Server 数据库的连接是否良好且存活。
  • GetSchema:可获取所有表及其相应架构、列和类型的列表。
  • Query:能在 Microsoft SQL Server 数据库中执行查询,并将结果以 JSON 格式返回。

📦 安装指南

使用 Claude 进行配置

  1. 填写 env.database 文件,使用您的 SQL Server 连接字符串。
  2. 编译项目。
  3. 在 Claude Desktop 中,转到 File->Configurations->Developer 并编辑 MCP 配置文件(claude_desktop_config.json)。
  4. 粘贴以下 JSON:
{
    "mcpServers": {
        "database": {
            "command": "dotnet",
            "args": [
                "run",
                "--project",
                "C:\\Users\\{USER}\\Desktop\\MCP-SqlServer",
                "--no-build"
            ]
        }
    }
}
  1. 重启 Claude Desktop。

💻 使用示例

基础用法

  • 测试连接状态:输入以下内容以测试连接状态: image
  • 查询架构和表信息:输入以下内容以获取数据库的架构和表信息: image
  • 执行读取查询:输入以下内容以执行读取查询: image
  • 执行修改操作:输入以下内容以执行数据库的修改操作: image

验证配置

打开 Claude Desktop,如果一切配置正确,您应该能看到: image 点击图标后,您应该能看到提供的工具。 image

📚 详细文档

  • 本项目主要是为了实现 MCP 服务器与 LLM 的集成,借助提供的工具可以方便地与 Microsoft SQL Server 数据库进行交互。
  • 通过配置 Claude Desktop,可以让 LLM 调用本项目提供的功能,实现数据库的连接测试、架构查询和数据操作等功能。

🔧 技术细节

本项目使用 C# 语言实现 MCP 服务器,通过 STDIO 与 LLM 进行交互。服务器将日志记录到 mcp_server.log 文件中,方便后续的问题排查和系统监控。同时,项目提供了三个主要工具,分别用于连接测试、架构查询和数据操作,这些工具通过与 Microsoft SQL Server 数据库进行交互,实现了相应的功能。

📄 许可证

文档未提及相关许可证信息。

提示信息

⚠️ 重要提示

LLM 可能会修改您的数据库,请谨慎使用。

💡 使用建议

在使用前,请确保已经正确配置 SQL Server 连接字符串和 Claude Desktop 的 MCP 配置文件,以保证项目的正常运行。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端