Mssqlclient MCP Server

🚀 SQL Server MCP 客戶端

SQL Server MCP 客戶端是一個基於 .NET 的程序，用於連接和操作 Microsoft SQL Server 數據庫。它通過實現 MCP（Microsoft Common Platform）協議，提供了與 SQL Server 交互的接口，方便用戶對數據庫進行各類操作。

🚀 快速開始

先決條件

• 安裝 .NET 運行時環境，以確保程序能夠正常運行。
• 確保安裝了 Docker（如果需要通過 Docker 運行）。
• 配備有效的 SQL Server 數據庫和相應的訪問權限。

構建指令

要從源代碼構建項目，請按照以下步驟操作：

1. 克隆此倉庫到本地開發環境。
2. 打開終端或命令提示符，導航至項目的根目錄。
3. 運行以下命令進行構建：

dotnet build --configuration Release

✨ 主要特性

• 數據庫連接：支持通過多種身份驗證方式連接到 SQL Server。
• 數據操作：提供基本的 CRUD（創建、讀取、更新、刪除）操作功能。
• 查詢執行：允許用戶執行自定義 SQL 查詢並查看結果集。
• 連接字符串配置：可以通過環境變量設置數據庫連接信息。

📦 安裝指南

Docker 支持

本地 Registry 使用

將項目構建成果發佈為 Docker 鏡像，並使用以下命令運行：

docker run -it --rm -e "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;" YOUR_REGISTRY/mssqlclient:latest

手動 Docker 構建

在項目的根目錄下，運行以下命令構建 Docker 鏡像：

docker build -t mssqlclient .

然後使用以下命令運行鏡像：

docker run -it --rm -e "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;" mssqlclient

Docker 推送

要將鏡像推送到私有或公共 Registry，請運行：

docker push YOUR_REGISTRY/mssqlclient:latest

📚 詳細文檔

MCP 協議使用方法

客戶端集成

在 Claude 桌面中配置 SQL Server MCP 客戶端，有兩種方式可供選擇。

本地安裝

1. 添加服務器配置到 Claude 桌面的配置文件中：

"mssql": {
  "command": "dotnet",
  "args": [
    "YOUR_PATH_TO_DLL\\Core.Infrastructure.McpServer.dll"
  ],
  "env": {
    "MSSQL_CONNECTIONSTRING": "Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;"
  }
}

2. 保存文件並重啟 Claude 桌面。

Docker 容器使用

1. 在 Claude 桌面配置中添加以下內容：

"mssql": {
  "command": "docker",
  "args": [
    "run",
    "--rm",
    "-i",
    "-e", "MSSQL_CONNECTIONSTRING=Server=your_server;Database=your_db;User Id=your_user;Password=your_password;TrustServerCertificate=True;",
    "localhost:5000/mssqlclient-mcp-server:latest"
  ]
}

2. 保存文件並重啟 Claude 桌面。

配置

數據庫連接字符串

配置 SQL Server 連接字符串時，請確保包含以下信息：

• 服務器名 或 IP 地址
• 數據庫名
• 身份驗證方式
• 用戶名 和 密碼

示例連接字符串：

Server=my-server;Database=my-database;User Id=my-user;Password=my-password;TrustServerCertificate=True;

⚠️ 注意事項

⚠️ 重要提示

確保所有環境變量和配置信息的安全性，避免洩露敏感數據。

💡 使用建議

在生產環境中使用前，請進行充分的測試和驗證。

📄 許可證

請參考項目的LICENSE文件獲取詳細許可信息。