article
README
🚀 Microsoft SQL Server 的 MCP 服务器
MSSQL MCP 服务器基于 Model Context Protocol (MCP),旨在实现与 Microsoft SQL Server (MSSQL) 数据库安全且结构化的交互。它允许 AI 助手执行列出可用表、读取表格内容、执行受控访问的 SQL 查询等操作,确保了更安全的数据库探索、严格的权限执行和对数据库交互的日志记录。
🚀 快速开始
MSSQL MCP 服务器能让 AI 助手与 MSSQL 数据库进行安全交互,可执行多种数据库操作,保障数据库使用的安全性和规范性。
✨ 主要特性
- 安全访问:通过环境变量实现 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 安全配置指南。
⚠️ 重要提示
始终遵循 最小特权原则 进行数据库访问配置。
贡献
我们欢迎贡献!要进行贡献:
- 叉仓库。
- 创建功能分支:
git checkout -b feature/amazing-feature - 提交更改:
git commit -m 'Add amazing feature' - 推送到分支:
git push origin feature/amazing-feature - 打开一个 Pull Request。
需要帮助?
对于任何问题或疑问,请随意打开 GitHub 上的 Issue 或联系维护者。
📄 许可证
此项目根据 MIT License 发布。有关详细信息,请参阅 LICENSE 文件。
扫码联系在线客服