Unraid MCP

🚀 Unraid MCP 服務器指南

本指南將詳細介紹 Unraid MCP 服務器的安裝、配置、功能使用、集成等方面，幫助您順利搭建並使用該服務器。

🚀 快速開始

環境要求

• 操作系統：Linux 或 Windows
• Python 版本：3.6+

下載與安裝

1. 克隆倉庫：

   git clone https://github.com/your-repository/unraid-mcp.git
   cd unraid-mcp
   

2. 安裝依賴：

   pip install -r requirements.txt
   

配置

創建配置文件 unraid_mcp_config.json：

{
  "mcpServers": {
    "unraid": {
      "command": "/path/to/python",
      "args": ["/path/to/unraid-mcp/run_server.py"],
      "env": {
        "UNRAID_API_URL": "http://your-unraid-server:port/graphql",
        "UNRAID_API_KEY": "your-api-key",
        "LOG_LEVEL": "INFO",
        "CLAUDE_MCP_SERVER": "true"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

✨ 主要特性

資源訪問

• unraid://system/info：系統信息（CPU、內存、運行時間）
• unraid://system/plugins：已安裝插件
• unraid://docker/containers：所有 Docker 容器列表
• unraid://docker/{container_name}：特定容器詳情
• unraid://array/status：當前存儲陣列狀態
• unraid://vms/list：所有虛擬機列表
• unraid://vms/{vm_name}：特定虛擬機詳情
• unraid://storage/shares：用戶共享信息

工具集

系統管理

• get_system_info：獲取詳細系統信息
• get_network_info：獲取網絡接口信息

存儲陣列管理

• get_array_status：以人類可讀格式顯示當前陣列狀態
• get_parity_history：獲取奇偶校驗檢查歷史記錄

Docker 管理

• get_docker_containers：獲取 Docker 容器信息
• get_docker_networks：獲取 Docker 網絡信息
• list_containers：以人類可讀格式列出 Docker 容器

虛擬機管理

• get_vms：獲取虛擬機信息
• get_vm_details：獲取特定虛擬機詳細信息
• list_vms：以人類可讀格式列出虛擬機

通知管理

• get_notifications：獲取服務器上的通知
• create_notification：創建新通知
• archive_notification：歸檔指定通知

共享管理

• get_shares：獲取網絡共享信息
• get_share_details：獲取特定共享詳細信息

磁盤管理

• get_disks：獲取所有磁盤信息
• get_disk_details：獲取特定磁盤詳細信息
• get_unassigned_devices：獲取未分配設備信息

用戶管理

• get_users：獲取所有用戶信息

API 密鑰管理

• get_api_keys：獲取所有 API 密鑰信息

📦 安裝指南

環境要求

• 操作系統：Linux 或 Windows
• Python 版本：3.6+

下載與安裝

1. 克隆倉庫：

   git clone https://github.com/your-repository/unraid-mcp.git
   cd unraid-mcp
   

2. 安裝依賴：

   pip install -r requirements.txt
   

配置

創建配置文件 unraid_mcp_config.json：

{
  "mcpServers": {
    "unraid": {
      "command": "/path/to/python",
      "args": ["/path/to/unraid-mcp/run_server.py"],
      "env": {
        "UNRAID_API_URL": "http://your-unraid-server:port/graphql",
        "UNRAID_API_KEY": "your-api-key",
        "LOG_LEVEL": "INFO",
        "CLAUDE_MCP_SERVER": "true"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

💻 使用示例

與 Claude 的集成

1. 創建配置文件：

   {
     "mcpServers": {
       "unraid": {
         "command": "/path/to/python",
         "args": ["/path/to/unraid-mcp/run_server.py"],
         "env": {
           "UNRAID_API_URL": "http://your-unraid-server:port/graphql",
           "UNRAID_API_KEY": "your-api-key",
           "LOG_LEVEL": "INFO",
           "CLAUDE_MCP_SERVER": "true"
         },
         "disabled": false,
         "autoApprove": []
       }
     }
   }
   

示例查詢

curl -X GET http://localhost:port/unraid//system/info

📚 詳細文檔

錯誤處理

常見問題

• 連接失敗：檢查 API 地址和密鑰是否正確。
• 權限問題：確保擁有足夠的訪問權限。

日誌查看

日誌文件位於 logs/unraid_mcp.log，包含詳細的錯誤信息。

升級與維護

更新代碼

git pull origin main
pip install -r requirements.txt

重啟服務

systemctl restart unraid-mcp

安全注意事項

• 密鑰管理：確保 API 密鑰的安全性，避免洩露。
• 網絡訪問：限制外部對 MCP 服務器的訪問。

通過以上步驟，您可以成功設置和使用 Unraid 的 MCP 服務器，並集成到您的開發環境中。如需進一步幫助，請參考官方文檔或聯繫支持團隊。