使用说明

项目简介

mssql-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当大型语言模型 (LLM) 客户端与 Microsoft SQL Server 数据库之间的桥梁。通过这个服务器，AI 助手可以在安全和受控的环境下访问和操作 SQL Server 数据库，实现如列出数据表、读取表数据、执行SQL查询等功能。

主要功能点

列出SQL Server表：将数据库中的表作为资源暴露给LLM客户端，方便客户端了解可用的数据资源。
读取表数据：允许LLM客户端读取指定表的内容，用于数据分析或上下文学习。
执行SQL查询：提供工具让LLM客户端能够执行自定义SQL查询，以满足更复杂的数据检索和操作需求。
安全性：通过环境变量管理数据库连接信息，并提供安全最佳实践建议，确保数据库访问的安全性。
易于安装和配置：支持通过pip快速安装，并通过简单的环境变量配置数据库连接。

安装步骤

确保你的环境中已安装 Python 和 pip。
使用 pip 安装 'mssql-mcp-server' 包：
```
pip install mssql-mcp-server
```
安装过程中会自动处理所需的系统依赖（如 FreeTDS）。

服务器配置

对于 MCP 客户端（例如 Claude Desktop），你需要在客户端的配置文件中添加 'mssql-mcp-server' 的相关配置。以下是一个 'claude_desktop_config.json' 示例，你需要根据你的实际环境进行调整：

{
  "mcpServers": {
    "mssql": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/your/project/directory", // 请替换为 mssql_mcp_server 项目的实际路径
        "run",
        "mssql_mcp_server"
      ],
      "env": {
        "MSSQL_SERVER": "your_mssql_server_host",   // 请替换为你的 MSSQL 服务器地址
        "MSSQL_USER": "your_database_username",      // 请替换为你的数据库用户名
        "MSSQL_PASSWORD": "your_database_password",  // 请替换为你的数据库密码
        "MSSQL_DATABASE": "your_database_name"      // 请替换为你要连接的数据库名称
      }
    }
  }
}

配置参数说明:

'server name': 可以自定义，用于在 MCP 客户端中标识此服务器，例如 "mssql"。
'command': 启动 MCP 服务器的命令，这里使用 'uv run'，假设你使用 'uv' 运行器，你也可以根据你的环境配置，例如直接使用 'python -m mssql_mcp_server'。
'args': 传递给 'command' 的参数。
- '--directory': 指定 'mssql_mcp_server' 项目所在的目录路径。请务必根据你的实际项目位置修改 'path/to/your/project/directory'。
- 'run mssql_mcp_server': 告诉 'uv' 运行器执行 'mssql_mcp_server' 包。
'env': 设置环境变量，用于配置数据库连接信息。
- 'MSSQL_SERVER': SQL Server 服务器地址（例如 'localhost' 或 IP 地址）。
- 'MSSQL_USER': 连接数据库的用户名。
- 'MSSQL_PASSWORD': 连接数据库的密码。
- 'MSSQL_DATABASE': 要连接的数据库名称。

注意: 请将 'path/to/your/project/directory', 'your_mssql_server_host', 'your_database_username', 'your_database_password', 和 'your_database_name' 替换为你的实际值。

基本使用方法

确保已安装 'mssql-mcp-server' 并配置好 MCP 客户端。
启动 MCP 客户端，客户端会根据配置连接到 'mssql-mcp-server'。
在 MCP 客户端中，你可以：
- 列出资源 (Resources)：查看 SQL Server 中可用的数据表。
- 读取资源 (Resources)：读取指定表的数据内容。
- 调用工具 (Tools)：使用 'execute_sql' 工具执行 SQL 查询，并获取查询结果。

具体操作方式取决于你使用的 MCP 客户端，请参考相应客户端的文档。

关键词