Unraid MCP

tv.tootie由 tootie.tv 发布v2.8.0更新于 Oct 24, 2026

MCP server for Unraid API — provides tools to interact with an Unraid server's GraphQL API.

发布方自己的服务:Cortex

概览

AI 生成的概览

本地 MCP 服务器,通过 Unraid 服务器的 GraphQL API 让助手查询和管理 NAS 状态。

可以做什么
  • 通过 GraphQL API 查询 Unraid 服务器
  • 读取阵列状态及其他服务器信息
  • 执行变更操作,例如虚拟机与 Docker 生命周期、阵列启停和通知写入(依据 README 对同仓库 Rust 服务器的描述)
适用场景
适合运行 Unraid 的用户,希望助手在对话中查看或操作服务器,而不必打开网页界面。主要面向已有 API 密钥和服务器地址的 Homelab 管理员。
运行要求
以 Python 包形式通过 uvx 在本地运行(需要 Python/uv 工具链)。需要环境变量 UNRAID_API_URL(Unraid 服务器基础地址)和 UNRAID_API_KEY(API 密钥)。需要能访问 Unraid 服务器的网络;若使用自签名证书,可能需要跳过 TLS 校验。
安装前请注意
API 密钥是访问 Unraid 服务器的机密,请勿放入共享配置。相关服务器明确并非只读:变更操作(虚拟机与 Docker 生命周期、阵列启停、通知写入)需要管理员权限,助手可能更改或停止服务。跳过 TLS 校验会削弱传输安全。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Unraid MCP,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

Unraid

[PyPI] [ghcr.io]

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

PathWhat it isToolchainBuild / test
unraid-py/unraid-mcp — Python MCP server (GraphQL), the flagship. Published to PyPI as unraid-mcp.Python / uv / hatchlingcd unraid-py && uv run pytest && uv build --wheel
unraid-rs/runraid — Rust MCP server + CLI (single static binary). Crate unraid-rmcp on crates.io, plus the compatibility npm launcher @dinglebear/unraid.Rust / cargocd unraid-rs && cargo fmt --check && cargo clippy --all-targets --features test-support -- -D warnings && cargo test
plugins/mcp/Unraid OS plugin that ships the Rust runraid MCP server onto an Unraid box.shell .plg + Rust + Vuebash plugins/mcp/scripts/build-txz.sh <ver> <runraid-binary>
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/Vuecd plugins/incus && ./scripts/verify-classic-package.sh && ./tests/classic-contract.sh
plugins/codex/Unraid OS plugin embedding a Codex chathead app-server.shell .plg + Reactcd plugins/codex && ./tests/contract.sh
agents/unraid-py/Claude Code / Codex plugin (name: unraid-mcp) for the Python server.——
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 and 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 filesrunraid array                              # read array staterunraid serve mcp                          # MCP HTTP (default :40010; configure auth)
Env varPurpose
UNRAID_API_URLUnraid GraphQL endpoint (required)
UNRAID_API_KEYx-api-key for the Unraid API (required)
UNRAID_API_SKIP_TLS_VERIFYAccept a self-signed Unraid cert (default false)
UNRAID_RMCP_HOST / UNRAID_RMCP_PORTMCP bind address (default 0.0.0.0:40010)
UNRAID_RMCP_TOKENStatic bearer token for /mcp
UNRAID_RMCP_AUTH_MODEbearer (default) or oauth

Full list and the OAuth variables: 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, the canonical contributor guide. CLAUDE.md and GEMINI.md are symlinks to it, including within components. The documentation index links to development and verification, architecture, and release procedures.

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.

来源:README.md,提交 605e484

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v2.8.0最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

其他 Tootie 集成