Microsoft SQL Server MCP Server

🚀 微软SQL Server MCP服务器

微软SQL Server MCP服务器是一个模型上下文协议（MCP）服务器，旨在实现与微软SQL Server数据库的安全交互。它允许AI助手通过受控接口列出表格、读取数据以及执行SQL查询，让数据库的探索和分析更加安全且有条理。

🚀 快速开始

本服务器可助力AI助手与微软SQL Server数据库安全交互，可通过以下步骤快速开启使用。

✨ 主要特性

• 列出可用的SQL Server表：将表作为资源进行管理。
• 读取表格内容：可直接读取表中数据。
• 执行SQL查询：具备完善的错误处理机制，保障查询顺利执行。
• 通过环境变量实现安全访问：保障数据库连接的安全性。
• 全面的日志记录：追踪所有操作，便于后续审计和排查问题。
• 自动安装系统依赖项：简化安装流程。

📦 安装指南

通过MCP安装时，会自动配置所需的系统依赖（如FreeTDS）：

pip install mssql-mcp-server

💻 使用示例

基础用法

与Claude桌面集成

将以下内容添加到claude_desktop_config.json文件中：

{
  "mcpServers": {
    "mssql": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/mssql_mcp_server",
        "run",
        "mssql_mcp_server"
      ],
      "env": {
        "MSSQL_SERVER": "localhost",
        "MSSQL_USER": "your_username",
        "MSSQL_PASSWORD": "your_password",
        "MSSQL_DATABASE": "your_database"
      }
    }
  }
}

作为独立服务器运行

# 安装依赖项
pip install -r requirements.txt

# 启动服务器
python -m mssql_mcp_server

高级用法

若你想参与项目开发，可参考以下步骤：

# 克隆仓库
git clone https://github.com/RichardHan/mssql_mcp_server.git
cd mssql_mcp_server

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # 或者 `venv\Scripts\activate` 在Windows系统中

# 安装开发依赖项
pip install -r requirements-dev.txt

# 执行测试
pytest

📚 详细文档

配置指南

设置以下环境变量以完成数据库连接的配置：

MSSQL_SERVER=localhost
MSSQL_USER=your_username
MSSQL_PASSWORD=your_password
MSSQL_DATABASE=your_database

安全注意事项

• 避免提交环境变量或凭证到版本控制系统，防止信息泄露。
• 使用权限受限的数据库用户，降低安全风险。
• 生产环境中建议实施查询白名单机制，严格控制可执行的查询。
• 监控并记录所有数据库操作，便于审计和问题排查。

安全最佳实践

此MCP服务器需要数据库访问权限才能正常运行。为确保安全：

1. 创建一个专用的SQL Server登录，并赋予最小的必要权限。
2. 避免使用sa凭证或其他管理账户，防止权限过大带来安全隐患。
3. 限制数据库访问权限仅限于必要的操作。
4. 启用日志记录以满足审计需求。
5. 定期进行安全审查针对数据库访问。

参考SQL Server安全配置指南获取详细说明，包括：

• 如何创建受限的SQL Server登录
• 设置适当的权限
• 监控数据库访问
• 安全最佳实践

⚠️ 重要提示

始终遵循最小特权原则来配置数据库访问。

贡献指南

1. ** Fork 仓库**
2. ** 创建功能分支**（例如：git checkout -b feature/amazing-feature）
3. ** 提交更改**（例如：git commit -m '添加某个精彩的功能'）
4. ** 推送到分支**（例如：git push origin feature/amazing-feature）
5. ** 提交Pull Request**

通过以上步骤，您可以为该项目贡献力量。

📄 许可证

采用MIT许可证，具体内容详见LICENSE文件。