# Unraid

<!-- mcp-name: tv.nashost/unraid-mcp -->

[![PyPI](https://img.shields.io/pypi/v/unraid-mcp)](https://pypi.org/project/unraid-mcp/) [![ghcr.io](https://img.shields.io/badge/ghcr.io-dinglebear--ai%2Funraid--mcp-blue?logo=docker)](https://github.com/dinglebear-ai/unraid/pkgs/container/unraid-mcp)

A monorepo of Unraid tooling: two MCP servers (Python and Rust) and three Unraid
OS plugins, plus the Claude/Codex agent integrations that surface them.

> **Repo name.** This repo was renamed `unraid-mcp` → `unraid` on 2026-07-27, and
> the former standalone `runraid` and `incus-unraid` repos were merged in here. Some
> deployed plugin install/update URLs still depend on the old-name redirect;
> migrating those runtime URLs requires a deliberate release. The **PyPI package, the container image, the Claude plugin, and the
> Unraid `.plg`** are all still named `unraid-mcp` — only the repo changed.

## Components

| Path | What it is | Toolchain | Build / test |
|------|-----------|-----------|--------------|
| [`unraid-py/`](unraid-py/) | **unraid-mcp** — Python MCP server (GraphQL), the flagship. Published to PyPI as `unraid-mcp`. | Python / uv / hatchling | `cd unraid-py && uv run pytest && uv build --wheel` |
| [`unraid-rs/`](unraid-rs/) | **runraid** — Rust MCP server + CLI (single static binary). Crate `unraid-rmcp` on crates.io, plus the compatibility npm launcher `@dinglebear/unraid`. | Rust / cargo | `cd unraid-rs && cargo fmt --check && cargo clippy --all-targets --features test-support -- -D warnings && cargo test` |
| [`plugins/mcp/`](plugins/mcp/) | Unraid OS plugin that ships the Rust `runraid` MCP server onto an Unraid box. | shell `.plg` + Rust + Vue | `bash plugins/mcp/scripts/build-txz.sh <ver> <runraid-binary>` |
| [`plugins/incus/`](plugins/incus/) | Unraid OS plugin running Incus system containers ("dev containers") firewalled off the LAN. Includes a NestJS/GraphQL `unraid-api` backend. | shell `.plg` + NestJS/Vue | `cd plugins/incus && ./scripts/verify-classic-package.sh && ./tests/classic-contract.sh` |
| [`plugins/codex/`](plugins/codex/) | Unraid OS plugin embedding a Codex chathead app-server. | shell `.plg` + React | `cd plugins/codex && ./tests/contract.sh` |
| [`agents/unraid-py/`](agents/unraid-py/) | Claude Code / Codex plugin (`name: unraid-mcp`) for the Python server. | — | — |
| [`agents/unraid-rs/`](agents/unraid-rs/) | Claude Code / Codex plugin (`name: runraid`) for the Rust server. | — | — |

## Install the agent plugins (one marketplace command, two manifests)

```text
/plugin marketplace add dinglebear-ai/unraid
/plugin install unraid-mcp@unraid-mcp   # Python server
/plugin install runraid@unraid-mcp      # Rust server
```

The `@unraid-mcp` suffix is the **marketplace name** declared in
`.claude-plugin/marketplace.json`, not the repo name — it stays `unraid-mcp` even
though the repo is now `dinglebear-ai/unraid`.

Both plugins are published from a single repo. Claude reads
`.claude-plugin/marketplace.json`; Codex reads `.agents/plugins/marketplace.json`.
`meta-ci.yml` asserts the two list the same plugin set, so they cannot drift.

`marketplace add` accepts the `owner/repo` shorthand (or a full git URL / local
path). After install, Claude Code prompts for the connection settings (the
plugin's `userConfig`).

### Plugin credentials need no manual step

The agent plugins ship **no Claude Code hooks**, and none are needed: both
`.mcp.json` files map your plugin settings into the server environment directly
via `${user_config.*}`. `agents/unraid-rs` wires endpoint, TLS, authentication, and tool-selector settings; `agents/unraid-py` wires `UNRAID_API_URL`
and `UNRAID_API_KEY`. Set them in plugin settings and the server picks them up on
next launch.

Optional, for **non-plugin** installs (systemd, Docker) that want `~/.unraid/.env`
written to disk:

```bash
runraid setup plugin-hook          # or: npx -y @dinglebear/unraid setup plugin-hook
```

## unraid-py quickstart (Python MCP server)

The Python server is the flagship. Full documentation — installation, Claude
Code / Codex / Gemini setup, configuration, authentication, guardrails, and the
tool surface — lives in **[`unraid-py/README.md`](unraid-py/README.md)** and
[`unraid-py/docs/`](unraid-py/docs/). It publishes to PyPI as `unraid-mcp` (import
package `unraid_mcp`) and launches with `uvx unraid-mcp`.

## unraid-rs quickstart (Rust MCP server + CLI)

```bash
cargo install --path unraid-rs --locked     # from the repository root
# Configure UNRAID_API_URL and UNRAID_API_KEY privately before querying.
runraid setup check                        # inspect setup without repairing files
runraid array                              # read array state
runraid serve mcp                          # MCP HTTP (default :40010; configure auth)
```

| Env var | Purpose |
|---|---|
| `UNRAID_API_URL` | Unraid GraphQL endpoint (required) |
| `UNRAID_API_KEY` | `x-api-key` for the Unraid API (required) |
| `UNRAID_API_SKIP_TLS_VERIFY` | Accept a self-signed Unraid cert (default `false`) |
| `UNRAID_RMCP_HOST` / `UNRAID_RMCP_PORT` | MCP bind address (default `0.0.0.0:40010`) |
| `UNRAID_RMCP_TOKEN` | Static bearer token for `/mcp` |
| `UNRAID_RMCP_AUTH_MODE` | `bearer` (default) or `oauth` |

Full list and the OAuth variables: [`unraid-rs/AGENTS.md`](unraid-rs/AGENTS.md).

**Not read-only.** The Rust server exposes both queries and mutations. Read actions
need the `unraid:read` scope; mutating actions (VM and Docker lifecycle, array
start/stop, notification writes) need `unraid:admin`.

## Development and documentation

Start with [AGENTS.md](AGENTS.md), the canonical contributor guide.
`CLAUDE.md` and `GEMINI.md` are symlinks to it, including within components.
The [documentation index](docs/README.md) links to
[development and verification](docs/DEVELOPMENT.md),
[architecture](docs/ARCHITECTURE.md), and [release procedures](docs/RELEASING.md).

Rust MCP supports `UNRAID_RMCP_PROJECTION=legacy` (default), `atomic`, or `both`.
All projections share enabled-action policy, scopes, and execution; atomic mode
is not a second backend. See the Rust README for selectors and migration.

## Releases

There are two release lanes. **release-please manages only `unraid-py` and
`unraid-rs`** — the Python server keeps unprefixed `vX.Y.Z` tags (the existing
audience's scheme) and Rust uses `unraid-rs-vX.Y.Z`. The **Incus and Codex plugins
do not use release-please**: they are versioned by
`.github/scripts/plugin_calver.py` with fixed-width `YYYYMMDD.NNN` versions and
`incus-v*` / `codex-v*` tags (Unraid compares plugin versions as raw strings, so the
fixed width is mandatory).

The native MCP plugin is built from the matching `unraid-rs-vX.Y.Z` tag, and Community Applications reads its rolling manifest from the `unraid-plugin-latest` release. Plugin `.txz` payloads ship as GitHub **release assets**, never tracked in git.

## License

MIT — see [LICENSE](LICENSE).