Unraid MCP

🚀 Unraid MCP Server Guide

This guide provides a comprehensive overview of setting up, configuring, and using the Unraid MCP server, including installation steps, feature descriptions, integration methods, and more.

🚀 Quick Start

Prerequisites

• Operating System: Linux or Windows
• Python Version: 3.6+

Download and Installation

1. Clone the repository:

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

2. Install dependencies:

   pip install -r requirements.txt
   

Configuration

Create a configuration file 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": []
    }
  }
}

✨ Features

Resource Access

• unraid://system/info: System information (CPU, memory, uptime)
• unraid://system/plugins: Installed plugins
• unraid://docker/containers: List of all Docker containers
• unraid://docker/{container_name}: Details of a specific container
• unraid://array/status: Current storage array status
• unraid://vms/list: List of all virtual machines
• unraid://vms/{vm_name}: Details of a specific virtual machine
• unraid://storage/shares: User share information

Toolset

System Management

• get_system_info: Get detailed system information
• get_network_info: Get network interface information

Storage Array Management

• get_array_status: Display the current array status in a human-readable format
• get_parity_history: Get parity check history

Docker Management

• get_docker_containers: Get Docker container information
• get_docker_networks: Get Docker network information
• list_containers: List Docker containers in a human-readable format

Virtual Machine Management

• get_vms: Get virtual machine information
• get_vm_details: Get detailed information of a specific virtual machine
• list_vms: List virtual machines in a human-readable format

Notification Management

• get_notifications: Get notifications on the server
• create_notification: Create a new notification
• archive_notification: Archive a specified notification

Share Management

• get_shares: Get network share information
• get_share_details: Get detailed information of a specific share

Disk Management

• get_disks: Get information of all disks
• get_disk_details: Get detailed information of a specific disk
• get_unassigned_devices: Get information of unassigned devices

User Management

• get_users: Get information of all users

API Key Management

• get_api_keys: Get information of all API keys

📚 Documentation

Integration with Claude

1. Create a configuration file:

   {
     "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": []
       }
     }
   }
   

Example Query

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

🔧 Technical Details

Error Handling

Common Issues

• Connection Failure: Check if the API address and key are correct.
• Permission Issues: Ensure you have sufficient access permissions.

Log Viewing

The log file is located at logs/unraid_mcp.log, which contains detailed error information.

Upgrade and Maintenance

Update Code

git pull origin main
pip install -r requirements.txt

Restart Service

systemctl restart unraid-mcp

📄 License

Security Precautions

• Key Management: Ensure the security of API keys and avoid leakage.
• Network Access: Restrict external access to the MCP server.

By following the above steps, you can successfully set up and use the Unraid MCP server and integrate it into your development environment. For further assistance, please refer to the official documentation or contact the support team.