unraid-rmcp

unraid-rmcp is a Rust MCP server and CLI for querying an Unraid NAS through the Unraid GraphQL API.

It exposes one MCP tool, unraid, plus the runraid CLI. Agents can inspect array health, disks, Docker containers and logs, VMs, shares, notifications, system metrics, UPS, logs, network settings, plugins, parity history, rclone, remote access, and Unraid Connect through stdio MCP, Streamable HTTP MCP, or direct shell commands.

30-second path: set UNRAID_API_URL and UNRAID_API_KEY, then run npx -y unraid-rmcp server --json -> start loopback HTTP with UNRAID_RMCP_HOST=127.0.0.1 npx -y unraid-rmcp serve mcp -> call tools/call with {"action":"server"}.

Status: operational RMCP upstream-client server. Read-only action surface; no Unraid mutations are exposed. HTTP MCP supports loopback dev mode, static bearer tokens, and Google OAuth through lab-auth. Release binaries and Docker images target linux/amd64 only.

Not for: replacing the Unraid web UI, mutating array/docker/VM state, running arbitrary shell commands, storing API keys for callers, multi-tenant isolation, or passing Unraid API keys through MCP tool arguments.

Contents

• Naming
• Capabilities And Boundaries
• Install
• Quickstart
• Client Configuration
• Runtime Surfaces
• MCP Tool Reference
• CLI Reference
• Configuration
• Authentication
• Safety And Trust Model
• Architecture
• Distribution Contract
• Development
• Verification
• Deployment
• Troubleshooting
• Related Servers
• Documentation
• License

Naming

This repo is a small naming exception in the RMCP family: MCP/server variables use UNRAID_RMCP_* rather than UNRAID_MCP_* for compatibility with the existing deployment config.

Capabilities And Boundaries

• Read Unraid array state, parity status, disk health, SMART summaries, and capacity.
• Read Docker containers, container logs, VMs, shares, notifications, services, network URLs, live metrics, config vars, registration, flash device details, UPS, plugins, parity history, rclone, remote access, and Unraid Connect.
• Provide pagination/filtering for MCP list actions and output truncation for large MCP responses.
• Expose the server_summary prompt and unraid://schema/mcp-tool schema resource.
• Provide setup and doctor commands for local plugin/runtime checks.

Install

npm / npx

Run the stdio MCP server or CLI without a manual binary install:

npx -y unraid-rmcp --help
npx -y unraid-rmcp mcp
npx -y unraid-rmcp server --json

The npm package downloads runraid during postinstall. Override download behavior only when testing packaging:

Build From Source

git clone https://github.com/jmagar/runraid
cd unraid-rmcp
cargo build --release
./target/release/runraid --help

Minimum supported Rust version: 1.90.

Quickstart

1. Configure Unraid

Create an Unraid API key in Settings -> API Management, then set:

export UNRAID_API_URL="https://10-1-0-2.<hash>.myunraid.net:31337/graphql"
export UNRAID_API_KEY="your-api-key-here"

Set UNRAID_API_SKIP_TLS_VERIFY=true only when your Unraid GraphQL endpoint uses a certificate your host does not trust.

2. Run A Safe CLI Call

npx -y unraid-rmcp server --json

3. Start Loopback HTTP MCP

UNRAID_RMCP_HOST=127.0.0.1 npx -y unraid-rmcp serve mcp

In another shell:

curl -sf http://127.0.0.1:40010/health

4. Make A First MCP Call

curl -s -X POST http://127.0.0.1:40010/mcp \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"unraid","arguments":{"action":"server"}}}'

Client Configuration

Claude Code Stdio

{
  "mcpServers": {
    "unraid": {
      "command": "npx",
      "args": ["-y", "unraid-rmcp", "mcp"],
      "env": {
        "UNRAID_API_URL": "https://10-1-0-2.<hash>.myunraid.net:31337/graphql",
        "UNRAID_API_KEY": "your-api-key-here"
      }
    }
  }
}

Claude Code HTTP

{
  "mcpServers": {
    "unraid": {
      "type": "http",
      "url": "http://127.0.0.1:40010/mcp",
      "headers": {
        "Authorization": "Bearer ${UNRAID_RMCP_TOKEN}"
      }
    }
  }
}

Codex / Labby Gateway

Register Unraid through Labby as an HTTP upstream when sharing one long-running server, or run it directly as stdio for local-only use.

[mcp_servers.unraid]
command = "npx"
args = ["-y", "unraid-rmcp", "mcp"]

Generic MCP JSON

{
  "command": "runraid",
  "args": ["mcp"],
  "env": {
    "UNRAID_API_URL": "https://10-1-0-2.<hash>.myunraid.net:31337/graphql",
    "UNRAID_API_KEY": "your-api-key-here"
  }
}

Do not put UNRAID_API_KEY, OAuth secrets, passwords, SSH keys, or upstream bearer tokens in MCP tool arguments. Use env, config files, or the MCP client's secret storage. MCP callers never provide credentials, tokens, keys, or secrets as action arguments.

Runtime Surfaces

MCP Tool Reference

One MCP tool is exposed: unraid. Pass the required action argument to select the operation.

Core Actions

System Actions

Log And Storage Actions

UPS, Remote, Plugin, And Meta Actions

Pagination and filtering are MCP-only. List actions return a paginated envelope with items, total, limit, offset, has_more, and next_offset.

CLI Reference

All CLI commands accept --json for machine-readable output.

runraid array [--json]
runraid disks [--json]
runraid docker [--json]
runraid docker logs <id> [--tail N] [--json]
runraid vms [--json]
runraid server [--json]
runraid info [--json]
runraid shares [--json]
runraid notifications [--json]
runraid services [--json]
runraid network [--json]
runraid metrics [--json]
runraid vars [--json]
runraid registration [--json]
runraid flash [--json]
runraid log-files [--json]
runraid log <path> [--lines N] [--start-line N] [--json]
runraid parity-history [--json]
runraid rclone [--json]
runraid ups [--json]
runraid ups-config [--json]
runraid remote-access [--json]
runraid connect [--json]
runraid plugins [--json]
runraid doctor [--json]
runraid setup check [--json]
runraid setup repair [--json]

status is MCP-only; setup and doctor are CLI-only.

Configuration

Host installs read ~/.unraid/.env before loading config. Containers read /data/.env. Process environment overrides both.

Authentication

Stdio MCP runs as a local trusted child process and does not use HTTP auth.

HTTP MCP auth policy:

All data actions are read-only. OAuth exposes unraid:read and unraid:admin scopes, but no mutating Unraid action is currently registered.

Safety And Trust Model

• Unraid API keys are loaded from config/env only.
• MCP callers select read actions and filters, not upstream credentials.
• No mutation, shell execution, filesystem write, Docker control, VM control, or array-control action is exposed.
• log_file reads through the Unraid GraphQL API, not arbitrary local files.
• Non-loopback HTTP deployments must use bearer auth, OAuth, or a trusted authenticated gateway.
• This bridge does not sandbox Unraid itself. Unraid remains responsible for API permissions and GraphQL response semantics.

Architecture

GraphQL queries (src/graphql.rs)  typed/read-only query construction
        |
UnraidService (src/app.rs)       action behavior and response shaping
        |
MCP shim      (src/mcp/tools.rs) JSON args -> service -> Value
CLI shim      (src/cli.rs)       argv -> service -> stdout

Distribution Contract

• Cargo.toml, Cargo.lock, packages/unraid-rmcp/package.json, .release-please-manifest.json, and server.json must agree on the released version.
• GitHub Releases publish the linux/amd64 runraid binary consumed by the npm launcher.
• The npm package name is unraid-rmcp; binary aliases are unraid-rmcp and runraid.
• Docker/OCI metadata uses ghcr.io/jmagar/runraid:<version>.
• plugins/unraid/.mcp.json must launch npx -y unraid-rmcp mcp so stdio clients start the MCP transport rather than the HTTP server.
• The root README is curated. docs/INVENTORY.md is the curated inventory for actions, CLI commands, env vars, HTTP endpoints, and dependencies.

Development

cargo fmt --check
cargo test
cargo clippy -- -D warnings
cargo build --release
npm --prefix packages/unraid-rmcp run check

Verification

python3 /home/jmagar/workspace/soma/scripts/check-readme-guide.py README.md
npm --prefix packages/unraid-rmcp run check
cargo check
cargo test
git diff --check

Runtime smoke:

UNRAID_API_URL=https://10-1-0-2.<hash>.myunraid.net:31337/graphql \
UNRAID_API_KEY=... \
runraid server --json

HTTP smoke:

UNRAID_RMCP_HOST=127.0.0.1 runraid serve mcp
curl -sf http://127.0.0.1:40010/health

Deployment

Use loopback for local development:

UNRAID_RMCP_HOST=127.0.0.1 runraid serve mcp

Use Docker Compose for shared HTTP deployment:

cp .env.example .env
docker compose up -d

When binding to a non-loopback address, configure UNRAID_RMCP_TOKEN, UNRAID_RMCP_AUTH_MODE=oauth, or UNRAID_NOAUTH=true behind an authenticated gateway.

Troubleshooting

Related Servers

• soma - RMCP runtime for provider-backed MCP servers.
• unifi-rmcp - UniFi controller REST API bridge.
• tailscale-rmcp - Tailscale API bridge for devices, users, and tailnet operations.
• apprise-rmcp - Apprise notification fan-out bridge for many delivery backends.
• gotify-rmcp - Gotify push notification bridge for sends, messages, apps, and clients.
• arcane-rmcp - Arcane Docker management bridge for containers and related resources.
• yarr - Media-stack bridge for Sonarr, Radarr, Prowlarr, Plex, and related services.
• ytdl-rmcp - Media download and metadata workflow server.
• synapse-rmcp - Local Synapse workflow server for scout and flux actions.
• cortex - Syslog and homelab log aggregation MCP server.
• axon - RAG, crawl, scrape, extract, and semantic search project.
• labby - Homelab control plane and MCP gateway project.
• lumen - Local semantic code search MCP server.

Documentation

• CLAUDE.md is the curated local operating guide for contributors and agents.
• docs/INVENTORY.md is the curated/generated inventory for actions, CLI commands, env vars, HTTP endpoints, and dependencies.
• docs/stack/ARCH.md is the curated architecture guide.
• docs/SETUP.md is curated plugin/setup guidance.
• docs/OAUTH.md is curated OAuth setup guidance.
• plugins/unraid/skills/unraid/SKILL.md is the agent usage guide.
• src/ is the source of truth for current GraphQL queries, config defaults, auth behavior, and CLI parsing.

License

MIT. See LICENSE.