Unraid MCP
GraphQL-backed MCP server for Unraid. Exposes a unified unraid tool for system inspection, management operations, live telemetry, and destructive actions gated by explicit confirmation.
Overview
The server translates MCP tool calls into Unraid GraphQL queries and mutations over HTTP and WebSocket. All operations share a single unraid tool routed by action + subaction. Live telemetry uses WebSocket subscriptions that stream real-time data from the Unraid API.
What this repository ships
unraid_mcp/ — server, GraphQL client, WebSocket subscriptions, config, and tool handlersskills/unraid/ — client-facing skill docsdocs/ — authentication, destructive-action, and publishing references.claude-plugin/, .codex-plugin/, gemini-extension.json — client manifestsdocker-compose.yaml, Dockerfile, entrypoint.sh — container deploymenttests/ — unit, safety, schema, HTTP-layer, and live coverage
Tools
Tool index
| Tool | Purpose |
|---|
unraid | Unified action/subaction router for all operations |
unraid_help | Returns this reference as Markdown |
diagnose_subscriptions | Full diagnostic dump of the WebSocket subscription system |
test_subscription_query | Probe a raw GraphQL subscription for schema/debug work |
unraid — action groups
All operations go through one tool. Pick an action, then a subaction within it.
system — 18 subactions
Server information, metrics, network, and UPS.
| Subaction | Description | Required params |
|---|
overview | OS, CPU, memory layout, versions, machine ID | — |
array | Array state, capacity, disk health summary | — |
network | Access URLs, HTTP/HTTPS ports, LAN/WAN IPs | — |
registration | License type, key file, expiration | — |
variables | Full Unraid variable set (timezone, shares, etc.) | — |
metrics | Live CPU % and memory usage | — |
services | Running services with name, online status, version | — |
display | Current UI theme name | — |
config | Config validity and error state | — |
online | Boolean reachability check | — |
owner | Owner username, avatar, profile URL | — |
settings | Unified settings key/value map | — |
server | Single-call summary: hostname, uptime, Unraid version, array state | — |
servers | All registered servers with LAN/WAN IPs and URLs | — |
flash | Flash drive vendor and product info | — |
ups_devices | All UPS devices with battery and power metrics | — |
ups_device | Single UPS device details | device_id |
ups_config | UPS daemon configuration | — |
health — 4 subactions
Connection and system health diagnostics.
| Subaction | Description | Required params |
|---|
check | Comprehensive health: API latency, array state, alerts, Docker container summary | — |
test_connection | Ping the Unraid API and return latency in ms | — |
diagnose | Subscription system status, error counts, reconnect state | — |
setup | Interactive credential setup (supports MCP elicitation) | — |
array — 13 subactions
Parity checks and array disk operations. Destructive subactions marked with *.
| Subaction | Description | Required params | Destructive |
|---|
parity_status | Current parity check progress, speed, errors | — | — |
parity_history | Past parity check results | — | — |
parity_start | Start a parity check | correct (bool) | — |
parity_pause | Pause a running parity check | — | — |
parity_resume | Resume a paused parity check | — | — |
parity_cancel | Cancel a running parity check | — | — |
start_array | Start the Unraid array | — | — |
stop_array | Stop the Unraid array | confirm=True | * |
add_disk | Add a disk to the array | disk_id; optional slot | — |
remove_disk | Remove a disk from the array (array must be stopped) | disk_id, confirm=True | * |
mount_disk | Mount an array disk | disk_id | — |
unmount_disk | Unmount an array disk | disk_id | — |
clear_disk_stats | Clear I/O statistics for a disk (irreversible) | disk_id, confirm=True | * |
disk — 6 subactions
Shares, physical disks, log files, and flash backup. Destructive subactions marked with *.
