Microsoft SQL Server MCP Server

🚀 微軟SQL Server MCP服務器

微軟SQL Server MCP服務器是一個模型上下文協議（MCP）服務器，旨在實現與微軟SQL Server數據庫的安全交互。它允許AI助手通過受控接口列出表格、讀取數據以及執行SQL查詢，讓數據庫的探索和分析更加安全且有條理。

🚀 快速開始

本服務器可助力AI助手與微軟SQL Server數據庫安全交互，可通過以下步驟快速開啟使用。

✨ 主要特性

• 列出可用的SQL Server表：將表作為資源進行管理。
• 讀取表格內容：可直接讀取表中數據。
• 執行SQL查詢：具備完善的錯誤處理機制，保障查詢順利執行。
• 通過環境變量實現安全訪問：保障數據庫連接的安全性。
• 全面的日誌記錄：追蹤所有操作，便於後續審計和排查問題。
• 自動安裝系統依賴項：簡化安裝流程。

📦 安裝指南

通過MCP安裝時，會自動配置所需的系統依賴（如FreeTDS）：

pip install mssql-mcp-server

💻 使用示例

基礎用法

與Claude桌面集成

將以下內容添加到claude_desktop_config.json文件中：

{
  "mcpServers": {
    "mssql": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/mssql_mcp_server",
        "run",
        "mssql_mcp_server"
      ],
      "env": {
        "MSSQL_SERVER": "localhost",
        "MSSQL_USER": "your_username",
        "MSSQL_PASSWORD": "your_password",
        "MSSQL_DATABASE": "your_database"
      }
    }
  }
}

作為獨立服務器運行

# 安裝依賴項
pip install -r requirements.txt

# 啟動服務器
python -m mssql_mcp_server

高級用法

若你想參與項目開發，可參考以下步驟：

# 克隆倉庫
git clone https://github.com/RichardHan/mssql_mcp_server.git
cd mssql_mcp_server

# 創建虛擬環境
python -m venv venv
source venv/bin/activate  # 或者 `venv\Scripts\activate` 在Windows系統中

# 安裝開發依賴項
pip install -r requirements-dev.txt

# 執行測試
pytest

📚 詳細文檔

配置指南

設置以下環境變量以完成數據庫連接的配置：

MSSQL_SERVER=localhost
MSSQL_USER=your_username
MSSQL_PASSWORD=your_password
MSSQL_DATABASE=your_database

安全注意事項

• 避免提交環境變量或憑證到版本控制系統，防止信息洩露。
• 使用權限受限的數據庫用戶，降低安全風險。
• 生產環境中建議實施查詢白名單機制，嚴格控制可執行的查詢。
• 監控並記錄所有數據庫操作，便於審計和問題排查。

安全最佳實踐

此MCP服務器需要數據庫訪問權限才能正常運行。為確保安全：

1. 創建一個專用的SQL Server登錄，並賦予最小的必要權限。
2. 避免使用sa憑證或其他管理賬戶，防止權限過大帶來安全隱患。
3. 限制數據庫訪問權限僅限於必要的操作。
4. 啟用日誌記錄以滿足審計需求。
5. 定期進行安全審查針對數據庫訪問。

參考SQL Server安全配置指南獲取詳細說明，包括：

• 如何創建受限的SQL Server登錄
• 設置適當的權限
• 監控數據庫訪問
• 安全最佳實踐

⚠️ 重要提示

始終遵循最小特權原則來配置數據庫訪問。

貢獻指南

1. ** Fork 倉庫**
2. ** 創建功能分支**（例如：git checkout -b feature/amazing-feature）
3. ** 提交更改**（例如：git commit -m '添加某個精彩的功能'）
4. ** 推送到分支**（例如：git push origin feature/amazing-feature）
5. ** 提交Pull Request**

通過以上步驟，您可以為該項目貢獻力量。

📄 許可證

採用MIT許可證，具體內容詳見LICENSE文件。