关键词

SQL Server数据库集成schema浏览查询执行存储过程

使用说明

项目简介

MCPSqlServer 是一个基于 Model Context Protocol (MCP) 的服务器，专为 Windsurf IDE 设计，旨在提供 SQL Server 数据库的集成能力。通过此服务器，Windsurf IDE 可以连接到 SQL Server 数据库，并利用其提供的工具浏览数据库结构、执行 SQL 查询和存储过程，从而增强 IDE 的数据库操作功能。

主要功能点

  • SQL Server 连接：支持连接到本地或远程 SQL Server 数据库。
  • 数据库结构浏览：允许客户端浏览数据库、表、视图和列的元数据信息。
  • SQL 查询执行：支持执行 SQL 查询，并返回查询结果。
  • 存储过程操作：能够枚举和执行存储过程，并获取存储过程的定义。
  • 调试模式：提供调试模式，方便问题排查和日志记录。

安装步骤

  1. 安装 .NET SDK：确保已安装 .NET 9.0 SDK 或更高版本。
  2. 构建项目：
    • 克隆或下载此 GitHub 仓库到本地。
    • 打开命令行终端，导航到仓库根目录。
    • 运行命令 'dotnet build' 构建项目。

服务器配置

要将 MCPSqlServer 配置为 Windsurf IDE 的 MCP 服务器，您需要编辑 Windsurf 的 MCP 配置文件。通常该文件位于 '~/.codeium/windsurf/mcp_config.json'。将以下 JSON 配置添加到 'mcpServers' 节点下。请根据实际构建输出路径修改 'command' 字段。

{
  "mcpServers": {
    "sqlMcpService": {
      "command": "path/to/your/MCPSqlServer.exe", // 将 "path/to/your/MCPSqlServer.exe" 替换为实际构建生成的 MCPSqlServer.exe 文件路径
      "args": [],
      "description": "SQL Server MCP Service"
    }
  }
}

配置说明：

  • 'command': 指向 MCPSqlServer.exe 可执行文件的路径。请根据您的构建输出目录进行调整。
  • 'args': 启动服务器时传递的命令行参数，此配置中为空数组，表示没有额外的启动参数。
  • 'description': 对该 MCP 服务器的描述，用于在 Windsurf IDE 中显示。

基本使用方法

  1. 配置 'appsettings.json'：
    • 复制 'appsettings.example.json' 文件到 'appsettings.json'。
    • 修改 'appsettings.json' 文件，配置 SQL Server 连接字符串 ('ConnectionStrings:DefaultConnection')、日志路径 ('LogPath') 和调试模式 ('DebugMode')。确保连接字符串中的服务器地址、数据库名称、用户名和密码正确。
  2. 启动 Windsurf IDE：
    • 确保 Windsurf IDE 已正确安装并配置了 MCP 服务器支持。
    • 启动 Windsurf IDE。IDE 应该会自动连接到配置的 MCPSqlServer MCP 服务器。
  3. 在 Windsurf IDE 中使用 SQL Server 功能：
    • Windsurf IDE 将通过 MCPSqlServer 提供的工具，允许您浏览 SQL Server 数据库的 schema，执行 SQL 查询，调用存储过程等操作。具体操作方式请参考 Windsurf IDE 的相关文档。

注意：

  • 确保 SQL Server 实例可访问，并且提供的连接字符串信息正确。
  • 日志文件将生成在 'appsettings.json' 中配置的 'LogPath' 目录下，用于问题排查。

信息

分类

数据库与文件

访问项目