SQL Server MCP Server for Windsurf IDE

基本能力

产品定位

MCPSqlServer 是一个为 Windsurf IDE 提供 SQL Server 集成功能的 MCP 服务器，旨在增强 IDE 的数据库开发能力。

核心功能

• SQL Server 连接
• 数据库模式探索
• 表和视图检查
• 列元数据检索
• 存储过程枚举
• SQL 查询执行
• 存储过程执行
• 调试模式
• 可配置的日志路径

适用场景

• 在 Windsurf IDE 中浏览数据库模式
• 执行 SQL 查询并查看结果
• 获取表和列名的代码补全
• 运行存储过程
• 生成 SQL 代码片段
• 分析数据库结构

工具列表

• dotnet build: 用于构建项目
• dotnet publish: 用于发布自包含的可执行文件
• git: 用于版本控制和 GitHub 集成

常见问题解答

• invalid_request: JSON 格式错误或缺少必填字段
• connection_failed: 连接 SQL Server 失败
• missing_parameter: 缺少必填参数
• query_execution_error: 执行 SQL 查询时出错
• database_not_found: 指定的数据库不存在
• table_not_found: 指定的表不存在

使用教程

使用依赖

• .NET 9.0 SDK 或更高版本
• SQL Server 实例（本地或远程）
• SQL Server 客户端工具

安装教程

1. 构建项目：

dotnet build

1. 配置应用程序：
2. 复制 appsettings.example.json 到 appsettings.json

3. 在 appsettings.json 中更新连接字符串和其他设置 json { "ConnectionStrings": { "DefaultConnection": "Server=your-server;Database=master;User ID=your-username;Password=your-password;TrustServerCertificate=True" }, "LogPath": "C:\\Path\\To\\Your\\LogDirectory\\", "DebugMode": "false" }

4. 在 Windsurf 中配置 MCP 服务器：

5. 复制 windsurf_mcp_config.json 的内容到 Windsurf MCP 配置文件

6. 更新路径以指向您的可执行文件 json { "mcpServers": { "sqlMcpService": { "command": "path/to/your/MCPSqlServer.exe", "args": [], "description": "SQL Server MCP Service" } } }

7. 设置 GitHub 集成：

8. 为您的项目创建一个新的 GitHub 仓库
9. 使用 git init 在项目目录中初始化一个新的 Git 仓库
10. 使用 git remote add origin <repository-url> 添加您的 GitHub 仓库作为远程仓库
11. 使用 git push -u origin master 将更改推送到远程仓库

调试方式

• 在 appsettings.json 中设置 "DebugMode": "true" 以启用详细调试日志
• 日志将写入 LogPath 指定的目录

发布

您可以发布应用程序为自包含的可执行文件：

dotnet publish -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true

许可证

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