Richardhan Mssql MCP Server

🚀 微軟SQL Server MCP服務器

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

✨ 主要特性

• 🔖 列出可用的SQL Server表作為資源。
• 📖 讀取表內容。
• 🛠️ 執行帶有適當錯誤處理的SQL查詢。
• 🔐 通過環境變量實現安全數據庫訪問。
• 📝 全面日誌記錄。
• ⚙️ 自動系統依賴項安裝。

📦 安裝指南

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

pip install mssql-mcp-server

🛠️ 配置

設置以下環境變量：

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

💻 使用示例

基礎用法

與Claude Desktop一起使用

將此內容添加到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

⚠️ 安全注意事項

⚠️ 重要提示

• 永遠不要提交環境變量或憑證。
• 使用權限最小的數據庫用戶。
• 考慮在生產環境中實施查詢白名單。
• 監控並記錄所有數據庫操作。

💡 使用建議

此MCP服務器需要數據庫訪問權限才能運行。為安全起見：

1. 創建一個專用的SQL Server登錄，具有最小的權限。
2. 絕不要使用sa憑證或管理賬戶。
3. 限制數據庫訪問僅限於必要的操作。
4. 啟用日誌記錄以進行審核。
5. 定期執行安全審查數據庫訪問。

參見SQL Server安全配置指南獲取詳細說明：

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

⚠️ 重要：始終遵循最小權限原則來配置數據庫訪問。

📄 許可證

MIT許可證 - 詳見LICENSE文件瞭解詳細信息。

🤝 貢獻指南

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。