Mcpsqlserver

🚀 SQL Server MCP 服務器用於 Windsurf IDE

本項目是一個獨立的 MCP（模型上下文協議）服務器，基於 C# 編寫，專門為 Windsurf IDE 提供 SQL Server 集成功能，助力用戶更便捷地操作 SQL Server 數據庫。

✨ 主要特性

• SQL Server 連接性：實現與 SQL Server 的穩定連接。
• 數據庫架構探索：可深入瞭解數據庫的整體架構。
• 表和視圖檢查：方便查看錶和視圖的具體情況。
• 列元數據檢索：精準獲取列的元數據信息。
• 存儲過程枚舉：對存儲過程進行全面枚舉。
• SQL 查詢執行：支持直接執行 SQL 查詢。
• 存儲過程執行：能夠執行存儲過程。
• 調試模式用於故障排除：開啟調試模式可快速定位並解決問題。
• 可配置的日誌路徑：用戶可自行設置日誌文件的存儲路徑。

📦 安裝指南

先決條件

• .NET 9.0 SDK 或更高版本
• SQL Server 實例（本地或遠程）
• SQL Server 客戶端工具

安裝步驟

1. 構建項目：

dotnet build

2. 配置應用程序：
   • 複製 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"
}

3. 在 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"
    }
  }
}

4. 設置 GitHub 集成：
   • 創建項目的新 GitHub 倉庫。
   • 在項目目錄中初始化新的 Git 倉庫使用 git init。
   • 將您的 GitHub 倉庫添加為遠程使用 git remote add origin <repository-url>。
   • 推送更改到遠程倉庫使用 git push -u origin master。

📚 詳細文檔

配置選項

appsettings.json 文件包含以下配置選項：

發佈

您可以發佈一個自包含的可執行文件：

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

這將生成一個單獨的可執行文件。

代碼結構

應用程序組織如下：

• Program.cs：主入口點和請求處理。
• JsonRpcHandler.cs：處理 JSON-RPC 協議並分發請求。
• 配置從 appsettings.json 加載。
• 日誌寫入由 LogPath 設置指定的文件。

貢獻

歡迎貢獻！請隨意提交一個 Pull Request。

1. 叉庫。
2. 創建您的功能分支 (git checkout -b feature/amazing-feature)。
3. 提交更改 (git commit -m 'Add some amazing feature')。
4. 推送到分支 (git push origin feature/amazing-feature)。
5. 打開一個 Pull Request。

錯誤處理

常見錯誤代碼：

📄 許可證

此項目在 MIT License 下許可 - 請查看 LICENSE 文件瞭解詳細信息。