项目简介

MSSQL MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为大型语言模型 (LLM) 应用提供与 Microsoft SQL Server 数据库交互的能力。通过此服务器，LLM 客户端可以安全、便捷地执行 SQL 查询、分析业务数据，并自动生成业务洞察报告。

主要功能点

数据查询与操作: 支持执行 'SELECT' 查询以读取数据，以及 'INSERT'、'UPDATE'、'DELETE' 查询以修改数据。
数据库结构管理: 允许创建新表、列出数据库中已有的表，并查看表的结构信息。
业务洞察记录: 提供工具用于记录和管理业务分析过程中的洞察发现，并自动生成业务洞察备忘录。
可定制Prompt: 内置 "mcp-demo" Prompt 模板，引导用户进行数据库探索和数据分析。
资源管理: 提供 "业务洞察备忘录" 资源，实时更新并可供 LLM 客户端访问。

安装步骤

环境准备:
- 确保已安装 'Python 3.x' 环境。
- 安装 'ODBC Driver 17 for SQL Server'。您可以从 Microsoft 官网下载并安装适合您操作系统的驱动。

下载仓库:

克隆 GitHub 仓库 'mssql-mcp' 到本地。

git clone https://github.com/daobataotie/mssql-mcp
cd mssql-mcp

安装依赖:

在仓库根目录下，使用 pip 安装项目依赖。

pip install -r requirements.txt

服务器配置

创建配置文件:
- 在 'src/server.py' 文件所在目录（通常为 'mssql-mcp/src'）下创建名为 'config.json' 的配置文件。

编辑配置文件:

根据您的 MSSQL 数据库连接信息，编辑 'config.json' 文件。以下是一个配置示例，请根据您的实际情况修改：

{
    "database": {
        "driver": "ODBC Driver 17 for SQL Server",  // ODBC 驱动名称，通常无需修改
        "server": "your_server_ip",          // MSSQL 服务器 IP 地址或主机名
        "database": "your_db_name",           // 数据库名称
        "username": "your_username",          // 数据库用户名
        "password": "your_password",          // 数据库密码
        "trusted_connection": false          // 是否使用 Windows 身份验证，通常为 false
    },
    "server": {
        "name": "mssql-manager",              // MCP 服务器名称，可自定义
        "version": "0.1.0",                   // MCP 服务器版本，可自定义
        "host": "0.0.0.0",                    // 服务器监听地址，0.0.0.0 表示监听所有地址
        "port": 8080                         // 服务器监听端口
    }
}

MCP 客户端配置示例

以下是在 MCP 客户端中配置 MSSQL MCP Server 的示例，以 Claude Desktop 为例。其他 MCP 客户端（如 Windsurf、Cursor、MCP Inspector）的配置方法类似。

Claude Desktop 配置 (claude_desktop_config.json):

在 Claude Desktop 的配置文件 'claude_desktop_config.json' 中添加 'mcpServers' 配置项。请注意将 'args' 中的路径替换为 'server.py' 文件的实际路径。

{
    "mcpServers": {
        "mssql": {
            "command": "python",
            "args": [
                "path/to/mssql-mcp/src/server.py"  // 替换为 server.py 文件的实际路径
            ]
        }
    }
}

Cursor 配置:

在 Cursor 中，您需要在 MCP 设置中手动添加集成。配置界面请参考 'README.md' 中提供的 'cursor_config.png' 图片。关键配置项与 Claude Desktop 类似，需要指定 'command' 为 'python'， 'args' 为 'server.py' 的路径。

MCP Inspector 配置:

使用 MCP Inspector 可以方便地测试和调试 MCP 服务器。在命令行中运行以下命令，将路径替换为 'server.py' 文件的实际路径。

npx -y @modelcontextprotocol/inspector python path/to/mssql-mcp/src/server.py  // 替换为 server.py 文件的实际路径

基本使用方法

启动 MCP 服务器:

打开终端，导航到 'mssql-mcp/src' 目录。
运行 'server.py' 启动 MCP 服务器。

cd path/to/mssql-mcp/src  // 替换为 server.py 文件所在目录的实际路径
python server.py

在 MCP 客户端中使用:
- 在配置好 MSSQL MCP Server 的 MCP 客户端中（如 Claude Desktop、Cursor），您应该能够看到名为 "mssql-manager" (或您在 'config.json' 中配置的名称) 的集成。
- 您可以使用预设的 "mcp-demo" Prompt 或直接调用服务器提供的 Tools (如 'read_query', 'write_query' 等) 与 MSSQL 数据库进行交互。
- 通过 "业务洞察备忘录" 资源，您可以查看和管理在分析过程中产生的业务洞察。

关键词