GUIDE

基本能力

产品定位

mcp-mssql 是一个用于连接和管理 Microsoft SQL Server 数据库的 MCP 服务。

核心功能

1. 虚拟环境管理：支持创建和激活 Python 3.10 虚拟环境。
2. 数据库连接配置：通过环境变量（.env 文件）配置 MSSQL 数据库连接信息。
3. 编辑器集成：支持与 Cursor 编辑器集成，通过 JSON 配置文件定义 MCP 服务器行为。
4. 数据库操作：提供基本的数据库连接和操作能力。

适用场景

1. 开发环境搭建：快速配置本地开发环境，连接 MSSQL 数据库。
2. 数据库调试：通过 Cursor 编辑器进行数据库连接测试和操作。
3. 自动化脚本：集成到自动化脚本中，实现数据库操作的自动化。

工具列表

1. 虚拟环境工具：用于创建和管理 Python 虚拟环境。
2. Cursor 编辑器：支持通过 JSON 配置文件集成 MCP 服务器。
3. MSSQL 客户端：用于连接和操作 MSSQL 数据库。

常见问题解答

1. 如何验证虚拟环境是否激活成功？
2. 运行 python --version 检查 Python 版本是否为 3.10。
3. 如何配置数据库连接信息？
4. 在 .env 文件中设置 MSSQL_SERVER、MSSQL_USER、MSSQL_PASSWORD、MSSQL_DATABASE 和 MSSQL_PORT。
5. 如何与 Cursor 编辑器集成？
6. 编辑 .cursor/mcp.json 文件，配置 MCP 服务器的命令、参数和环境变量。

使用教程

使用依赖

1. Python 3.10：确保系统已安装 Python 3.10。

安装教程

1. 创建虚拟环境： bash python3.10 -m venv venv
2. 激活虚拟环境：
3. macOS 和 Linux： bash source venv/bin/activate
4. 验证 Python 版本： bash python --version
5. 配置数据库连接：
6. 创建 .env 文件并添加以下内容： bash MSSQL_SERVER=localhost MSSQL_USER=SA MSSQL_PASSWORD=YourStrong@Passw0rd MSSQL_DATABASE=localdatabase MSSQL_PORT=1433
7. 集成 Cursor 编辑器：
8. 编辑 .cursor/mcp.json 文件，配置 MCP 服务器： 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" } } } }

调试方式

1. 检查连接：
2. 在 Cursor 编辑器中选择 AGENT 模式，输入提示："Use MSSQL MCP server to check connection"。
3. 验证环境变量：
4. 确保 .env 文件中的数据库连接信息正确。
5. 检查日志：
6. 查看 Cursor 编辑器的输出日志，确认连接是否成功。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。