Richardhan Mssql MCP Server

🚀 微软SQL Server MCP服务器

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

✨ 主要特性

• 🔖 列出可用的SQL Server表作为资源。
• 📖 读取表内容。
• 🛠️ 执行带有适当错误处理的SQL查询。
• 🔐 通过环境变量实现安全数据库访问。
• 📝 全面日志记录。
• ⚙️ 自动系统依赖项安装。

📦 安装指南

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

pip install mssql-mcp-server

🛠️ 配置

设置以下环境变量：

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

💻 使用示例

基础用法

与Claude Desktop一起使用

将此内容添加到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

⚠️ 安全注意事项

⚠️ 重要提示

• 永远不要提交环境变量或凭证。
• 使用权限最小的数据库用户。
• 考虑在生产环境中实施查询白名单。
• 监控并记录所有数据库操作。

💡 使用建议

此MCP服务器需要数据库访问权限才能运行。为安全起见：

1. 创建一个专用的SQL Server登录，具有最小的权限。
2. 绝不要使用sa凭证或管理账户。
3. 限制数据库访问仅限于必要的操作。
4. 启用日志记录以进行审核。
5. 定期执行安全审查数据库访问。

参见SQL Server安全配置指南获取详细说明：

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

⚠️ 重要：始终遵循最小权限原则来配置数据库访问。

📄 许可证

MIT许可证 - 详见LICENSE文件了解详细信息。

🤝 贡献指南

1. 复刻仓库。
2. 创建功能分支（git checkout -b feature/amazing-feature）。
3. 提交更改（git commit -m 'Add some amazing feature'）。
4. 推送到分支（git push origin feature/amazing-feature）。
5. 打开Pull Request。