使用说明

项目简介

本项目是一个 MCP 服务器，旨在为 LLM 应用提供查询 SQL Server 数据库结构信息的能力。它通过提供工具，允许 LLM 获取数据库中的表名、列信息以及表之间的关系，从而增强 LLM 对数据库上下文的理解。

主要功能点

获取数据库表名: 允许 LLM 获取 SQL Server 数据库中所有用户表的名称。
获取表列信息: 允许 LLM 获取指定表的列名、数据类型、是否可为空、是否为标识列、是否为主键等详细信息。
获取表关系: 允许 LLM 获取 SQL Server 数据库中表与表之间的外键关系。

安装步骤

环境准备: 确保您的机器上已安装 .NET 9 运行时环境和 SQL Server 数据库。
下载代码: 从 GitHub 仓库 https://github.com/jdlemes/MsSqlMCP 克隆或下载源代码。
配置数据库连接: 修改 'MsSqlMCP/appsettings.json' 文件，将 'DefaultConnection' 的连接字符串替换为您的 SQL Server 数据库连接信息。请确保连接字符串指向您希望 LLM 查询的数据库。
启动服务器: 打开命令行终端，导航到代码仓库的根目录 'MsSqlMCP' 文件夹，运行命令 'dotnet run --project MsSqlMCP.csproj' 启动 MCP 服务器。服务器成功启动后，将监听 MCP 客户端的请求。

服务器配置（用于MCP客户端）

要将此 MCP 服务器配置到 MCP 客户端（例如 Visual Studio Code 的 MCP 插件），您需要在客户端的配置文件（通常是 'settings.json'）中添加以下 'servers' 配置。

"servers": {
    "MsSqlMCP": {
        "type": "stdio",
        "command": "dotnet",
        "args": [
            "run",
            "--project",
            "MsSqlMCP.csproj"
        ]
    }
}

配置说明:

'type': 指定连接类型为 'stdio'，表示 MCP 客户端将通过标准输入/输出流与 MCP 服务器进行通信。
'command': 指定启动 MCP 服务器的命令，这里使用 'dotnet' 命令来运行 .NET 项目。
'args': 传递给 'dotnet' 命令的参数，'run --project MsSqlMCP.csproj' 指示运行 'MsSqlMCP.csproj' 项目，即启动 SQL Server Schema MCP Server。

注意： 'command' 和 'args' 配置需要与您实际启动服务器的方式保持一致。如果您的 MCP 客户端和服务器不在同一目录下，您可能需要调整 'args' 中的项目路径。

基本使用方法

成功配置并启动 MCP 服务器后，在 MCP 客户端中，您就可以通过配置的服务器名称 "MsSqlMCP" 调用服务器提供的工具来查询 SQL Server 数据库的 Schema 信息。具体的工具调用方式和请求格式，请参考您的 MCP 客户端的使用文档。例如，您可以发送请求调用 'GetTables' 工具来获取数据库中的所有表名，或调用 'GetColumns' 工具并指定表名来获取表的列信息。

关键词