Monitor and manage your Unraid server's array, Docker containers, VMs, ZFS pools, and logs using plain English via any MCP client.
Also known as mswdev/better-unraid-mcp, better-unraid-mcp
- Stars
- 3
- Tools
- 67
- Downloads, 30 days
- —
- Latest version
- 0.1.1
- Last commit
- Nov 13, 2026
- License
- MIT
What is Better Unraid MCP?
Better Unraid monitors and manage your Unraid server's array, Docker containers, VMs, ZFS pools, and logs using plain English via any MCP client. It exposes 67 tools, such as system_info, array_status, parity_history.
Summary generated from the project's README
About Better Unraid MCP server
Managing an Unraid server through natural language is what this MCP server enables for home lab enthusiasts and sysadmins. By connecting to any MCP client like Claude Desktop, Claude Code, or Gemini CLI, you can monitor and control your server without using the WebGUI or SSH manually. The server communicates with your Unraid instance via the built-in GraphQL API using a single API key, and it can be run locally via npx or through a Docker container.
The server provides 67 specialized tools to handle tasks ranging from checking array health and disk temperatures to managing Docker containers and ZFS pools. It includes safety features like a read-only mode and mandatory confirmation flags for destructive actions to prevent accidental changes. For deeper system access, it supports an optional SSH connection to perform tasks like reading specific host files, managing User Scripts, or running shell commands. This setup allows you to diagnose issues, such as degraded arrays or container resource usage, through a simple conversation.
What you can do with it
- 1Manage Docker containersInstruct your AI client to restart a specific container or check its current resource usage.
- 2Monitor system logsRequest the AI to tail the system log to troubleshoot recent server events.
- 3Control virtual machinesUse natural language to perform a graceful shutdown or a hard reset on a running VM.
Written from the project's README. Every use case is checked against a quote from it.
How to install Better Unraid MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall Better Unraid MCP in Claude Code
$ claude mcp add --env 'UNRAID_API_KEY=<YOUR_UNRAID_API_KEY>' --env 'UNRAID_API_URL=<UNRAID_API_URL>' --env 'UNRAID_SSH_PASSWORD=<YOUR_UNRAID_SSH_PASSWORD>' better-unraid-mcp -- npx -y better-unraid-mcpInstall Better Unraid MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"better-unraid-mcp": {
"command": "npx",
"args": [
"-y",
"better-unraid-mcp"
],
"env": {
"UNRAID_API_KEY": "<YOUR_UNRAID_API_KEY>",
"UNRAID_API_URL": "<UNRAID_API_URL>",
"UNRAID_SSH_PASSWORD": "<YOUR_UNRAID_SSH_PASSWORD>"
}
}
}
}Install Better Unraid MCP in VS Code
.vscode/mcp.json
{
"servers": {
"better-unraid-mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"better-unraid-mcp"
],
"env": {
"UNRAID_API_KEY": "<YOUR_UNRAID_API_KEY>",
"UNRAID_API_URL": "<UNRAID_API_URL>",
"UNRAID_SSH_PASSWORD": "<YOUR_UNRAID_SSH_PASSWORD>"
}
}
}
}Install Better Unraid MCP in VS Code CLI
$ code --add-mcp '{"name":"better-unraid-mcp","type":"stdio","command":"npx","args":["-y","better-unraid-mcp"],"env":{"UNRAID_API_KEY":"<YOUR_UNRAID_API_KEY>","UNRAID_API_URL":"<UNRAID_API_URL>","UNRAID_SSH_PASSWORD":"<YOUR_UNRAID_SSH_PASSWORD>"}}'Install Better Unraid MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"better-unraid-mcp": {
"command": "npx",
"args": [
"-y",
"better-unraid-mcp"
],
"env": {
"UNRAID_API_KEY": "<YOUR_UNRAID_API_KEY>",
"UNRAID_API_URL": "<UNRAID_API_URL>",
"UNRAID_SSH_PASSWORD": "<YOUR_UNRAID_SSH_PASSWORD>"
}
}
}
}Install Better Unraid MCP in Codex
$ codex mcp add better-unraid-mcp --env 'UNRAID_API_KEY=<YOUR_UNRAID_API_KEY>' --env 'UNRAID_API_URL=<UNRAID_API_URL>' --env 'UNRAID_SSH_PASSWORD=<YOUR_UNRAID_SSH_PASSWORD>' -- npx -y better-unraid-mcpInstall Better Unraid MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.better-unraid-mcp] command = "npx" args = ["-y", "better-unraid-mcp"] [mcp_servers.better-unraid-mcp.env] UNRAID_API_KEY = "<YOUR_UNRAID_API_KEY>" UNRAID_API_URL = "<UNRAID_API_URL>" UNRAID_SSH_PASSWORD = "<YOUR_UNRAID_SSH_PASSWORD>"
Install Better Unraid MCP in Gemini CLI
$ gemini mcp add -s user -e 'UNRAID_API_KEY=<YOUR_UNRAID_API_KEY>' -e 'UNRAID_API_URL=<UNRAID_API_URL>' -e 'UNRAID_SSH_PASSWORD=<YOUR_UNRAID_SSH_PASSWORD>' better-unraid-mcp npx -- -y better-unraid-mcpInstall Better Unraid MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"better-unraid-mcp": {
"command": "npx",
"args": [
"-y",
"better-unraid-mcp"
],
"env": {
"UNRAID_API_KEY": "<YOUR_UNRAID_API_KEY>",
"UNRAID_API_URL": "<UNRAID_API_URL>",
"UNRAID_SSH_PASSWORD": "<YOUR_UNRAID_SSH_PASSWORD>"
}
}
}
}Needs a key before it starts
Started on 16 Nov 2026 with no keys, it stopped and asked for one, so a client sees no tools until you set the variables above.
Better Unraid MCP tools 67
Detected from the READMEsystem_infoarray_statusparity_historydisk_listdisk_smart_reportdisk_spinshare_listmover_statussystem_healthconnection_doctorgpu_metricsprocess_list
Show all 67 toolsShow fewer tools
mover_actionsystem_powerarray_actionarray_disk_actionparity_checkdocker_container_listdocker_container_logsdocker_network_listdocker_port_conflictsdocker_statsdocker_container_actiondocker_container_removedocker_container_updatedocker_autostart_setvm_listvm_actionvm_snapshot_listvm_snapshot_createnotification_overviewnotification_listnotification_alertsnotification_archivenotification_unreadnotification_createnotification_recalculatenotification_deletelog_listlog_readsystem_metricsmetrics_historyplugin_listplugin_addplugin_removeplugin_install_plgzfs_statuszfs_dataset_listzfs_snapshot_listzfs_snapshot_actionservice_listservice_actionunassigned_listunassigned_actionshare_createshare_editshare_deleteflash_backupuser_script_listuser_script_runapikey_listapikey_manageups_statusfile_readshell_execgraphql_querygraphql_mutation
Configuration
UNRAID_API_KEYRequiredSecretUnraid API key (Settings → Management Access → API Keys)
UNRAID_API_URLRequiredFull Unraid GraphQL endpoint, including /graphql
UNRAID_SSH_PASSWORDSecretOptional: SSH password (or set UNRAID_SSH_KEY_PATH)
MCP_HTTP_BEARER_TOKENMCP_READ_ONLYSet true to register only read-only tools
MCP_TRANSPORTUNRAID_SSH_HOSTOptional: SSH host for host-level tools
Automated checks
Ran Nov 13, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablePass
- Open source license (OSI)Pass
- Commit or release in the last yearPass
- Package name not close to a popular packagePass
- Remote endpoint uses HTTPSNot checked
- Destructive tools are labelledNot checked
- No hidden instructions to the modelPass
- No critical advisory in the package or its dependenciesPass
README
View on GitHubBetter Unraid MCP
Monitor and manage your Unraid server in plain English, from any MCP client.
Features · Quick start · Tools · MCP features · Configuration · HTTP transport · Security · Development
Better Unraid MCP is a Model Context Protocol server for the Unraid GraphQL API. Connect it to Claude Desktop, Claude Code, Codex, Gemini CLI, or any other MCP client and ask things like "why is my array degraded?", "tail the syslog", or "restart the Plex container".
Features
Ask a plain question and get a real answer from your server. "Why is my array degraded?" turns into calls to array_status and disk_list, and you find out which disk is unhappy and what SMART thinks of it without opening an SSH session or clicking through WebGUI tabs.
The 67 tools cover most of what you would normally do over SSH or in the WebGUI:
- Diagnose problems in one conversation: unread alerts, CPU and memory pressure, network errors, disk temperatures, SMART health
- Read any log on the server: list them all, tail the syslog, or page through the middle of a huge file
- Manage Docker: container status and logs, per-container resource usage, start and stop, image updates, port conflict detection, boot autostart order
- Control VMs through libvirt, from a graceful shutdown to a hard reset
- Run the array: start or stop it, manage parity checks, review parity history, check the mover
- Triage notifications: read, archive, and clear the alerts you have been putting off
- Watch the UPS during an outage: battery charge, runtime estimate, load
- Go past the API when you need to (optional, via SSH): read any file on the host, such as
/boot/logs/syslog-previous, or run a confirmed one-off command - Work with ZFS: pool health, datasets, snapshots (create, destroy, rollback), and ARC usage
- Reach the host when the API can't: processes, GPU metrics, disk spin, SMART deep reports, User Scripts, VM snapshots
- Manage the platform itself: API keys, native
.plgplugin installs, mover control, reboot and shutdown - Watch things live: WebSocket-fed resources for parity progress, Docker stats, system metrics (CPU, memory, network, temperature), UPS, array state, notifications, and log following (
unraid://live/*,unraid://logs/{path}) - Reach the rest of the API with raw
graphql_queryand a confirm-gatedgraphql_mutationwhile dedicated tools catch up
The tools are deliberately paranoid. A destructive tool refuses to run unless the request includes confirm: true, so a stray sentence in a chat can't stop your array. The operations that can really hurt (stopping the array, hard-killing a VM, rebooting the host) also need acknowledge_risk: true. If your client supports MCP elicitation, you get an interactive confirmation prompt instead. Every read works with a viewer-level API key, and MCP_READ_ONLY=true takes every state-changing tool out of the listing.
You don't install anything on the Unraid server. The MCP server runs on your machine, talks to Unraid's built-in GraphQL API with one API key, and starts with a single npx command.
Quick start
1. Create an Unraid API key
On your Unraid server (7.2 or newer), go to Settings > Management Access > API Keys and create a key. Or from the Unraid terminal:
unraid-api apikey --create
[!IMPORTANT] The key controls your server, so treat it like a password and give it the least privilege you need. A viewer-level key is enough for every read-only tool.
2. Add the server to your MCP client
claude mcp add better-unraid \
-e UNRAID_API_URL=https://tower.local/graphql \
-e UNRAID_API_KEY=your-api-key \
-- npx -y better-unraid-mcp@latest
Add an entry to the mcpServers object in your claude_desktop_config.json:
{
"mcpServers": {
"better-unraid": {
"command": "npx",
"args": ["-y", "better-unraid-mcp@latest"],
"env": {
"UNRAID_API_URL": "https://tower.local/graphql",
"UNRAID_API_KEY": "your-api-key"
}
}
}
}
codex mcp add better-unraid \
--env UNRAID_API_URL=https://tower.local/graphql \
--env UNRAID_API_KEY=your-api-key \
-- npx -y better-unraid-mcp@latest
Or add a server table to ~/.codex/config.toml:
[mcp_servers.better-unraid]
command = "npx"
args = ["-y", "better-unraid-mcp@latest"]
env = { UNRAID_API_URL = "https://tower.local/graphql", UNRAID_API_KEY = "your-api-key" }
Add an entry to the mcpServers object in ~/.gemini/settings.json:
{
"mcpServers": {
"better-unraid": {
"command": "npx",
"args": ["-y", "better-unraid-mcp@latest"],
"env": {
"UNRAID_API_URL": "https://tower.local/graphql",
"UNRAID_API_KEY": "your-api-key"
}
}
}
}
If your server uses a self-signed TLS certificate on the LAN, also set UNRAID_ALLOW_SELF_SIGNED=true. To turn on the SSH-backed tools (reading files like /boot/logs/syslog-previous, ZFS, running one-off commands, and the rest of the tools marked SSH below), also pass the UNRAID_SSH_* variables described under Configuration. @latest keeps you on the newest release; pin a version (for example better-unraid-mcp@0.1.1) if you want fully predictable behavior.
Other ways to install
All of them run the same server, and none of them install anything on the Unraid box.
| Option | Details |
|---|---|
| Claude Desktop, one click | Download better-unraid-mcp-<version>.mcpb from the latest release and open it. Claude Desktop asks for the URL and API key. |
| Claude Code plugin marketplace | claude plugin marketplace add mswdev/better-unraid-mcp, then claude plugin install better-unraid@better-unraid-mcp. The plugin reads UNRAID_API_URL and UNRAID_API_KEY from your environment. |
| Docker (remote HTTP transport) | ghcr.io/mswdev/better-unraid-mcp. See Docker. |
| MCP Registry | Listed as io.github.mswdev/better-unraid-mcp for clients that browse the registry. |
Cautious quickstart (read-only)
Not ready to let a model touch anything? Add MCP_READ_ONLY=true to the environment above and the server registers only the read-only tools. The state-changing tools aren't refused at call time; they never appear at all. Pair that with a VIEWER-role API key and nothing in this server can change your machine.
3. Verify your setup
Before wiring up a client, run the built-in doctor with the same environment:
UNRAID_API_URL=https://tower.local/graphql UNRAID_API_KEY=... npx better-unraid-mcp doctor
It prints one line per check (GraphQL reachability and versions, schema skew against the server's API version, SSH when configured, rate limiting, and read-only mode) and exits non-zero when something is broken:
✓ Reachable in 12 ms — Unraid 7.3.2, API 4.37.4+ad268301, online=true.
✓ Vendored schema matches the server API (4.37.4 vs 4.37.4+ad268301).
⚠ SSH: not configured (optional). Host tools (...) are unavailable; set UNRAID_SSH_* to enable them.
✓ Client-side rate limiting active: 90 request burst, 9/s refill.
✓ read-only mode: disabled — mutating tools are registered (each behind its confirm gate).
doctor: OK
4. Try it
Ask your client:
"What's the status of my Unraid array?"
Tools
Read-only tools never change anything. Destructive tools always require confirm: true; without it they refuse and leave your server alone.
| Category | Tools |
|---|---|
| System and storage | 14 |
| Array control | 3 |
| Docker | 9 |
| Virtual machines | 4 |
| Notifications | 8 |
| Observability | 4 |
| Plugins | 4 |
| ZFS (SSH) | 4 |
| Host configuration (SSH) | 7 |
| Backup (SSH) | 1 |
| User Scripts (SSH) | 2 |
| API keys | 2 |
| UPS | 1 |
| Host shell (optional, needs SSH) | 2 |
| Raw GraphQL (advanced) | 2 |
Speed and safety
The SSH channel is one kept-alive connection: it connects lazily, sends keepalive probes, reconnects on its own, and closes after UNRAID_SSH_IDLE_SECONDS of idle time, so commands don't pay for a new handshake each time. GraphQL requests reuse a keep-alive HTTP agent and have a hard 30-second timeout, and idempotent queries get a small jittered retry on transient failures. The busiest reads (system_metrics, array_status, docker_container_list) come from a 5-second snapshot cache, and detailed output includes data_age_ms so you can see how fresh the data is. Long-running shell_exec and docker_container_update calls send MCP progress notifications when the client asks for them (stdio or session-mode HTTP).
All tool output goes through secret redaction: your configured API key, SSH password, and bearer token, plus credential-shaped key/value pairs and JWTs, come back as [redacted]. A client-side rate limiter keeps request bursts inside the Unraid API's throttle, and oversized JSON results are truncated into an envelope that still parses with JSON.parse.
System and storage
| Tool | Type | Description |
|---|---|---|
system_info |
read-only | OS, kernel, uptime, hostname, and CPU summary. |
array_status |
read-only | Array state, capacity, current parity-check status, and per-disk health. |
parity_history |
read-only | Recent parity checks (date, status, errors, speed). |
disk_list |
read-only | Physical disks with model, size, SMART status, temperature, and partitions. |
disk_smart_report |
read-only | Full smartctl attribute report for one disk (SSH). |
disk_spin |
mutation | Spins a disk up or down (SSH; confirm): array slots through emhttpd so the state stays consistent, unassigned /dev/sdX through sdspin (ATA only). |
share_list |
read-only | User shares with usage; filter by name. |
mover_status |
read-only | Whether the mover (cache-to-array migration) is running, plus its schedule. |
system_health |
read-only | One severity-scored health rollup (OK / WARNING / CRITICAL) across array, capacity, disks and temperatures, parity, notifications, UPS, and pending container updates. Start here. |
connection_doctor |
read-only | Self-test of this MCP server's plumbing: GraphQL reachability and latency, API key validity, versions, schema skew (vendored schema vs the server's API version), SSH connectivity, rate-limit config, and read-only mode. Run it first when something misbehaves; it is also available as npx better-unraid-mcp doctor. |
gpu_metrics |
read-only | GPU utilization over SSH: full metrics from nvidia-smi, a one-line summary (frequency, idle share, engine load, GPU clients) parsed from intel_gpu_top, or a clear report when neither is present. |
process_list |
read-only | The host's busiest processes by CPU or memory (SSH). |
mover_action |
destructive | Starts or stops the mover over SSH (requires confirm: true). Stopping can leave partial files on the destination. |
system_power |
destructive | Reboots or shuts down the whole server over SSH. Requires confirm: true and acknowledge_risk: true. |
Array control
Both tools require an API key with the ADMIN role. They report that the request was issued; run array_status afterward to confirm the result.
| Tool | Type | Description |
|---|---|---|
array_action |
destructive | Starts or stops the array. Stopping takes every share, container, and VM offline, so stop also requires acknowledge_risk: true. |
array_disk_action |
destructive | Adds a disk to the array (checks first that the array is STOPPED), mounts or unmounts an array disk, or clears disk statistics. The Unraid API (4.37+) no longer supports removing a disk, so use the web UI for that. Requires confirm + acknowledge_risk. |
parity_check |
destructive | Starts (optionally correcting), pauses, resumes, or cancels a parity check. |
Docker
| Tool | Type | Description |
|---|---|---|
docker_container_list |
read-only | Containers with state, image, and update availability; filter by name. |
docker_container_logs |
read-only | Recent log lines for a container, with tail and time-based paging. |
docker_network_list |
read-only | Docker networks (driver, scope, IPv6/internal/attachable). |
docker_port_conflicts |
read-only | Container and LAN port conflicts. |
docker_stats |
read-only | Per-container CPU, memory, network, and block IO usage, hungriest first. Uses a fresh sample from the live WebSocket subscription when one exists and otherwise falls back to docker stats over SSH (see Host shell); the response says which source it used. |
docker_container_action |
destructive | Start, stop, pause, unpause, or restart a container (restart uses the API's native restart mutation, API 4.37+). |
docker_container_remove |
destructive | Permanently deletes a container (irreversible) and optionally its image. Needs Unraid 7.3+. |
docker_container_update |
destructive | Pulls the latest image and recreates containers, by id or all with updates. Needs Unraid 7.3+. |
docker_autostart_set |
destructive | Sets which containers start on boot without losing the existing boot order. Needs Unraid 7.3+. |
Virtual machines
| Tool | Type | Description |
|---|---|---|
vm_list |
read-only | Virtual machines with run state; filter by name. |
vm_action |
destructive | Start, stop, pause, resume, forceStop, reboot, or reset a VM by name or id. forceStop and reset are ungraceful and also require acknowledge_risk: true. |
vm_snapshot_list |
read-only | Lists a VM's libvirt snapshots through virsh (SSH; the GraphQL API doesn't expose them). |
vm_snapshot_create |
destructive | Creates an EXTERNAL disk snapshot through virsh, the same way Unraid 7 does. Requires confirm + acknowledge_risk. Revert and delete stay in the Unraid UI on purpose. |
Notifications
| Tool | Type | Description |
|---|---|---|
notification_overview |
read-only | Unread and archived counts broken down by importance. |
notification_list |
read-only | Notifications by type (unread or archive) with paging; the source of truth for ids. |
notification_alerts |
read-only | Deduplicated unread warnings and alerts: the "needs attention now" view. |
notification_archive |
mutation | Archives or unarchives notifications (reversible, no confirmation needed). The API swallows per-id failures, so verify with notification_list. |
notification_unread |
mutation | Marks one notification as unread again (reversible, no confirmation needed). |
notification_create |
mutation | Creates a notification (no confirmation needed). |
notification_recalculate |
mutation | Re-syncs cached overview counts from disk (no confirmation needed). |
notification_delete |
destructive | Permanently deletes notifications (irreversible). |
Observability
| Tool | Type | Description |
|---|---|---|
log_list |
read-only | The server's log files with size and last-modified time. |
log_read |
read-only | Tails or windows a log file (default 100 lines, max 2000), with paging hints. |
system_metrics |
read-only | Point-in-time CPU load, memory pressure, per-interface network rates, and server time. Temperature data is opt-in. |
metrics_history |
read-only | Recent CPU, memory, and network history from the opt-in in-memory recorder (MCP_METRICS_HISTORY=true): 30-second min/avg/max buckets for up to 24 hours, with gaps reported as gaps. When recording is off, it says how to turn it on. |
Plugins
| Tool | Type | Description |
|---|---|---|
plugin_list |
read-only | Installed API plugins and OS .plg plugins. |
plugin_add |
destructive | Installs API plugins by npm package name, then restarts the Unraid API. npm install on your server runs package lifecycle scripts, so only install packages you trust. |
plugin_remove |
destructive | Uninstalls API plugins by npm package name, then restarts the Unraid API. |
plugin_install_plg |
destructive | Installs a native Unraid OS plugin from a .plg URL. A .plg runs arbitrary code as root, so this requires confirm + acknowledge_risk. Only install from sources you trust. |
ZFS (SSH)
ZFS ships with Unraid 6.12+. These tools say so plainly when no pools exist.
| Tool | Type | Description |
|---|---|---|
zfs_status |
read-only | Pool health and capacity, plus ARC memory usage. |
zfs_dataset_list |
read-only | Datasets with used and available space and mountpoints; optional pool filter. |
zfs_snapshot_list |
read-only | Snapshots with size and creation time; optional dataset filter. |
zfs_snapshot_action |
destructive | Create, destroy, or roll back a snapshot. Rollback discards everything after the snapshot, so this requires confirm + acknowledge_risk. |
Host configuration (SSH)
The GraphQL API has nothing for services, share changes, or unassigned devices, so these tools use the same mechanisms as the web UI: the /etc/rc.d/rc.* scripts, emhttpd's form handler through emcmd, and the Unassigned Devices plugin. Every write is checked by reading the result back.
| Tool | Type | Description |
|---|---|---|
service_list |
read-only | Running, stopped, or not-installed state of samba, nfs, sshd, docker, libvirt, and tailscale. |
service_action |
destructive | restart, start, or stop one of those services, then check its status. stop needs allow_stop: true, and stopping docker or libvirt is refused (use array_action). Requires confirm + acknowledge_risk. |
unassigned_list |
read-only | Disks outside the array, pools, and flash, with partitions, filesystems, and mount points. |
unassigned_action |
destructive | Mounts or unmounts an unassigned partition through the Unassigned Devices plugin (rc.unassigned) and checks the result with lsblk. Refuses when the plugin isn't installed. Requires confirm + acknowledge_risk. |
share_create |
destructive | Creates a user share through emhttpd with a validated subset of settings (comment, allocator, cache mode and pool, SMB export and security), then checks the written .cfg. Requires confirm + acknowledge_risk. |
share_edit |
destructive | Changes that same subset of settings on an existing share, leaves the other settings alone, and checks the result by reading it back. Requires confirm + acknowledge_risk. |
share_delete |
destructive | Deletes an EMPTY share's configuration. It never deletes files and refuses while the share holds data. Requires confirm + acknowledge_risk. |
Backup (SSH)
| Tool | Type | Description |
|---|---|---|
flash_backup |
destructive | Archives the flash (USB boot) device into a user share as /mnt/user/<share>/flash-backups/flash-backup-<scope>-<timestamp>.tar.gz: /boot/config by default, or the whole flash with full: true. Each archive is checked with tar -tzf, and keep: N prunes older archives and lists what it removed. The archive contains your license key, API keys, and passwords, so it stays on your array. Requires confirm + acknowledge_risk. |
User Scripts (SSH)
| Tool | Type | Description |
|---|---|---|
user_script_list |
read-only | Lists scripts managed by the User Scripts plugin. |
user_script_run |
destructive | Runs one user script with the plugin's noexec-safe runner. A user script is arbitrary root code, so this requires confirm + acknowledge_risk. |
API keys
These tools hand the model the credentials that control access to your server, so use them with the same care as the keys themselves.
| Tool | Type | Description |
|---|---|---|
apikey_list |
read-only | Lists configured API keys (name, roles, permissions, created). Key values are never selected or returned. |
apikey_manage |
destructive | Creates, updates, adds or removes roles on, or deletes API keys. Requires confirm + acknowledge_risk. The key value is shown exactly once, at creation. Deleting the key this MCP server uses locks it out. |
UPS
| Tool | Type | Description |
|---|---|---|
ups_status |
read-only | Live UPS telemetry from apcupsd: status (ONLINE, ONBATT, LOWBATT, ...), battery charge and runtime, and power load. When apcaccess has nothing to report, it says "no live UPS data" instead of erroring or inventing a healthy reading. That includes NUT-managed servers, which the Unraid API can't see. |
Better Unraid MCP questions
How do I add Better Unraid MCP to Claude Code?
Run claude mcp add --env 'UNRAID_API_KEY=<YOUR_UNRAID_API_KEY>' --env 'UNRAID_API_URL=<UNRAID_API_URL>' --env 'UNRAID_SSH_PASSWORD=<YOUR_UNRAID_SSH_PASSWORD>' better-unraid-mcp -- npx -y better-unraid-mcp in your terminal. Add --scope user to make it available in every project.
How do I add Better Unraid MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does Better Unraid MCP provide?
It exposes 67 tools, including system_info, array_status, parity_history, disk_list, disk_smart_report.
Do I need to install anything on my Unraid server?
No, the MCP server runs on your local machine and communicates with Unraid's built-in GraphQL API.