MSSQL MCP Server 使用说明

项目简介

MSSQL MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型 (LLM) 提供安全且结构化的 Microsoft SQL Server 数据库访问能力。通过此服务,AI 助手可以安全地浏览数据库中的表,读取表内容,并执行受控的 SQL 查询,从而实现与 MSSQL 数据库的有效集成。

主要功能点

  • 安全数据库访问: 通过环境变量配置 MSSQL 数据库连接,保障敏感信息安全。
  • 可控查询执行: 提供执行 SQL 查询的工具,并具备错误处理机制,确保查询操作的稳定性。
  • 表数据浏览: 支持列出数据库中的可用表,并读取表中的数据内容。
  • 操作日志记录: 记录所有数据库交互操作,便于监控和审计。

安装步骤

  1. 确保你的 Python 环境已安装 pip。
  2. 打开终端或命令提示符,运行以下命令安装 MSSQL MCP Server:
    pip install mssql-mcp-server

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)连接到 MSSQL MCP Server,你需要配置客户端的 MCP 服务器设置。以下是一个 Claude Desktop 客户端的 'claude_desktop_config.json' 配置文件示例,展示了如何配置 MSSQL MCP Server:

{
  "mcpServers": {
    "mssql": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/your/mssql_mcp_server",  // 请替换为 mssql_mcp_server 所在目录的绝对路径
        "run",
        "mssql_mcp_server"
      ],
      "env": {
        "MSSQL_DRIVER": "your_mssql_driver",  // 请替换为你的 MSSQL 驱动名称,例如 'ODBC Driver 17 for SQL Server'
        "MSSQL_HOST": "your_mssql_host",      // 请替换为你的 MSSQL 服务器地址,例如 'localhost' 或 IP 地址
        "MSSQL_USER": "your_db_username",     // 请替换为你的 MSSQL 数据库用户名
        "MSSQL_PASSWORD": "your_db_password", // 请替换为你的 MSSQL 数据库密码
        "MSSQL_DATABASE": "your_database_name"// 请替换为你要访问的 MSSQL 数据库名称
      }
    }
  }
}

配置参数说明:

  • 'server name': 'mssql' (服务器名称,客户端内唯一标识即可)
  • 'command': 'uv' (运行命令,这里假设你已安装 'uv',你也可以使用 'python' 或其他 Python 运行器)
  • 'args': 启动服务器的参数列表。
    • '--directory': 指定 'mssql_mcp_server' 所在的目录。请务必将 '/path/to/your/mssql_mcp_server' 替换为实际的目录绝对路径。
    • 'run': uv 的运行子命令。
    • 'mssql_mcp_server': 指定要运行的 Python 模块名。
  • 'env': 环境变量配置,用于 MSSQL 服务器连接。
    • 'MSSQL_DRIVER': MSSQL 驱动名称,需要与你的环境匹配。
    • 'MSSQL_HOST': MSSQL 服务器地址。
    • 'MSSQL_USER': MSSQL 数据库用户名。
    • 'MSSQL_PASSWORD': MSSQL 数据库密码。
    • 'MSSQL_DATABASE': MSSQL 数据库名称。

注意: 请根据你的实际环境修改上述配置中的占位符,确保路径、驱动、数据库连接信息正确无误。

基本使用方法

  1. 确保 MSSQL MCP Server 已成功安装并配置到 MCP 客户端。
  2. 启动 MCP 客户端 (如 Claude Desktop)。客户端会自动连接并初始化 MSSQL MCP Server。
  3. 在 MCP 客户端中,你可以指示 AI 助手使用 "mssql" 服务器提供的功能,例如:
    • 让 AI 助手列出数据库中的表。
    • 让 AI 助手读取特定表的数据内容。
    • 让 AI 助手执行 SQL 查询来检索或操作数据。

具体如何指示 AI 助手取决于 MCP 客户端的功能和交互方式。通常,你可以通过自然语言指令引导 AI 助手使用 MCP 服务器提供的资源和工具。

信息

分类

数据库与文件