MCP SQL Server

用于Windsurf IDE的SQL Server MCP服务器

一个用C#编写的独立MCP（模型上下文协议）服务器，作为Windsurf IDE的插件提供SQL server集成功能。

特性

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

先决条件

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

设置

1. 构建项目：

dotnet build

1. 配置应用程序：

- 复制 appsettings.example.json 向 appsettings.json - 更新中的连接字符串和其他设置 appsettings.json 包含您的SQL Server详细信息

   {
     "ConnectionStrings": {
       "DefaultConnection": "Server=your-server;Database=master;User ID=your-username;Password=your-password;TrustServerCertificate=True"
     },
     "LogPath": "C:\\Path\\To\\Your\\LogDirectory\\",
     "DebugMode": "false"
   }

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

- 复制以下内容 windsurf_mcp_config.json 到您的Windsurf MCP配置文件（通常位于 ~/.codeium/windsurf/mcp_config.json) - 更新路径以指向您构建的可执行文件：

   {
     "mcpServers": {
       "sqlMcpService": {
         "command": "path/to/your/MCPSqlServer.exe",
         "args": [],
         "description": "SQL Server MCP Service"
       }
     }
   }

1. 设置GitHub集成：

- 为您的项目创建一个新的GitHub存储库 - 使用以下命令在项目目录中初始化新的Git存储库 git init - 使用远程方式添加您的GitHub存储库 git remote add origin - 使用以下命令将您的更改推送到远程存储库 git push -u origin master

配置选项

这 appsettings.json 文件包含以下配置选项：

• ConnectionStrings:DefaultConnection：SQL Server连接字符串
• LogPath：存储日志文件的目录
• DebugMode：设置为“true”以启用详细的调试日志记录

出版

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

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

这将创建一个包含所有依赖项的单个可执行文件。

协议

MCP服务器使用基于JSON的协议通过标准输入/输出进行通信。

请求格式

{
  "id": "request-id",
  "action": "action-name",
  "parameters": {
    "param1": "value1",
    "param2": "value2"
  }
}

响应格式

{
  "success": true,
  "data": {
    "key": "value"
  }
}

或者，如果出现错误：

{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Error description"
  }
}

支持的操作

1.连接到SQL Server

{
  "action": "connect",
  "parameters": {
    "connectionString": "Data Source=server;Initial Catalog=master;Integrated Security=True;"
  }
}

2.列出数据库

{
  "action": "get_databases",
  "parameters": {}
}

3.列出数据库中的表

{
  "action": "get_tables",
  "parameters": {
    "database": "AdventureWorks"
  }
}

4.获取表列

{
  "action": "get_columns",
  "parameters": {
    "database": "AdventureWorks",
    "schema": "Person",
    "table": "Person"
  }
}

5.列出存储过程

{
  "action": "get_procedures",
  "parameters": {
    "database": "AdventureWorks"
  }
}

6.执行数据库查询

{
  "action": "execute_database_query",
  "parameters": {
    "database": "AdventureWorks",
    "query": "SELECT TOP 10 * FROM Person.Person",
    "parameters": {
      "param1": "value1"
    }
  }
}

7.执行系统查询

{
  "action": "execute_system_query",
  "parameters": {
    "query": "SELECT name FROM sys.databases",
    "parameters": {
      "param1": "value1"
    }
  }
}

8.执行存储过程

{
  "action": "execute_procedure",
  "parameters": {
    "database": "AdventureWorks",
    "schema": "dbo",
    "procedure": "uspGetEmployeeManagers",
    "parameters": {
      "BusinessEntityID": 5
    }
  }
}

与Windsurf集成

此MCP服务器可从Windsurf IDE用于：

1. 浏览数据库架构
2. 执行SQL查询并查看结果
3. 获取表名和列名的代码补全
4. 运行存储过程
5. 生成SQL代码片段
6. 分析数据库结构

编码结构

应用程序分为以下组件：

• Program.cs：主要入口点和请求处理
• JsonRpcHandler.cs：处理JSON-RPC协议并分派请求
• 配置从加载 appsettings.json
• 日志被写入由指定的文件 LogPath 设置

贡献

欢迎投稿！请随时提交拉取请求。

1. 分叉存储库
2. 创建功能分支(git checkout -b feature/amazing-feature)
3. 提交您的更改(git commit -m 'Add some amazing feature')
4. 推到分支(git push origin feature/amazing-feature)
5. 打开拉取请求

许可证

此项目根据MIT许可证获得许可-有关详细信息，请参阅许可证文件。

错误处理

常见错误代码：

• invalid_request：JSON格式错误或缺少必填字段
• connection_failed：无法连接到SQL Server
• missing_parameter：未提供必需参数
• query_execution_error：执行SQL查询时出错
• database_not_found：指定的数据库不存在
• table_not_found：指定的表不存在