article
README
🚀 MSSQL MCP 服务器
MSSQL MCP 服务器基于 Model Context Protocol (MCP) 构建,旨在实现与 Microsoft SQL Server (MSSQL) 数据库安全且结构化的交互。它允许 AI 助手列出可用表、查看表内容并执行受控访问的 SQL 查询,确保了更安全的数据库探索、严格的权限控制以及对数据库交互的日志记录。
🚀 快速开始
MSSQL MCP 服务器为与 MSSQL 数据库的交互提供了安全且结构化的方式。以下是使用该服务器的基本步骤:
- 安装服务器。
- 配置数据库访问。
- 根据需求集成到 Claude Desktop 或作为独立服务器运行。
✨ 主要特性
- 安全访问:通过环境变量实现对 MSSQL 数据库的安全访问。
- 受控查询:具备错误处理功能,可执行 受控查询。
- 数据检索:提供表目录及数据检索功能。
- 全面日志:拥有全面的日志记录,便于监控查询和操作。
📦 安装指南
使用以下命令安装 mssql-mcp-server:
pip install mssql-mcp-server
📦 配置
通过设置以下环境变量来配置数据库访问:
MSSQL_DRIVER=mssql_driver
MSSQL_HOST=localhost
MSSQL_USER=your_username
MSSQL_PASSWORD=your_password
MSSQL_DATABASE=your_database
# 可选
TrustServerCertificate=yes
Trusted_Connection=no
💻 使用示例
基础用法
集成到 Claude Desktop
要在 Claude Desktop 中集成,将以下配置添加到 claude_desktop_config.json 文件中:
{
"mcpServers": {
"mssql": {
"command": "uv",
"args": [
"--directory",
"path/to/mssql_mcp_server",
"run",
"mssql_mcp_server"
],
"env": {
"MSSQL_DRIVER": "mssql_driver",
"MSSQL_HOST": "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/yourusername/mssql_mcp_server.git
cd mssql_mcp_server
# 创建虚拟环境
python -m venv venv
source venv/bin/activate # 在 Windows 上:venv\Scripts\activate
# 安装开发依赖项
pip install -r requirements-dev.txt
# 运行测试
pytest
📚 详细文档
安全注意事项
- 使用具有最小权限的 MSSQL 用户。
- 绝对不要使用根凭据或拥有完全管理权限的账户。
- 限制数据库访问,仅允许必要的操作。
- 启用日志记录和监控功能以进行安全审计。
- 定期审查权限,确保遵循最小权限原则。
安全最佳实践
为了实现安全配置:
- 创建一个具有受限权限的 MSSQL 用户。
- 避免硬编码凭据——使用环境变量来管理。
- 限制访问,仅授予必要的表和操作权限。
- 启用 SQL Server 日志记录和监控功能。
- 定期审查数据库访问权限,防止未经授权的访问。
有关详细说明,请参阅 MSSQL 安全配置指南。
⚠️ 重要提示
始终遵循 最小权限原则 来配置数据库访问。
📄 许可证
此项目根据 MIT License 许可。有关详细信息,请参阅 LICENSE 文件。
🤝 贡献
我们欢迎贡献!要进行贡献,请按照以下步骤操作:
- 分叉仓库。
- 创建功能分支:
git checkout -b feature/amazing-feature - 提交更改:
git commit -m 'Add amazing feature' - 推送到分支:
git push origin feature/amazing-feature - 打开一个 Pull Request。
需要帮助?
对于任何问题或疑问,请联系 此处。
微信扫一扫