api-reference
**⚠️ DEVELOPER REFERENCE ONLY** — This file documents the raw GraphQL API schema for development and maintenance purposes (adding…
**⚠️ DEVELOPER REFERENCE ONLY** — Full GraphQL SDL from live API introspection. Use this to verify field names and types when adding new queries/mutations to the MCP server. Not for runtime agent usage.
> /plugin marketplace add dinglebear-ai/unraidHow it fires
How this agent gets triggered: by you, by Claude, or both.
Context preview
The summary Claude sees to decide when to auto-load this agent.
**⚠️ DEVELOPER REFERENCE ONLY** — Full GraphQL SDL from live API introspection. Use this to verify field names and types when adding new queries/mutations to the MCP server. Not for runtime agent usage.
> **⚠️ DEVELOPER REFERENCE ONLY** — Full GraphQL SDL from live API introspection. Use this to verify field names and types when adding new queries/mutations to the MCP server. Not for runtime agent usage.
""" Indicates exactly one field must be supplied and this field must not be `null`. """ directive @oneOf on INPUT_OBJECT
"""Directive to document required permissions for fields""" directive @usePermissions( """The action required for access (must be a valid AuthAction enum value)""" action: String
"""The resource required for access (must be a valid Resource enum value)""" resource: String ) on FIELD_DEFINITION
type ParityCheck { """Date of the parity check""" date: DateTime
"""Duration of the parity check in seconds""" duration: Int
"""Speed of the parity check, in MB/s""" speed: String
"""Status of the parity check""" status: ParityCheckStatus!
"""Number of errors during the parity check""" errors: Int
"""Progress percentage of the parity check""" progress: Int
"""Whether corrections are being written to parity""" correcting: Boolean
"""Whether the parity check is paused""" paused: Boolean
"""Whether the parity check is running""" running: Boolean }
""" A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format. """ scalar DateTime
enum ParityCheckStatus { NEVER_RUN RUNNING PAUSED COMPLETED CANCELLED FAILED }
type Capacity { """Free capacity""" free: String!
"""Used capacity""" used: String!
"""Total capacity""" total: String! }
type ArrayCapacity { """Capacity in kilobytes""" kilobytes: Capacity!
"""Capacity in number of disks""" disks: Capacity! }
type ArrayDisk implements Node { id: PrefixedID!
""" Array slot number. Parity1 is always 0 and Parity2 is always 29. Array slots will be 1 - 28. Cache slots are 30 - 53. Flash is 54. """ idx: Int! name: String device: String
"""(KB) Disk Size total""" size: BigInt status: ArrayDiskStatus
"""Is the disk a HDD or SSD.""" rotational: Boolean
"""Disk temp - will be NaN if array is not started or DISK_NP""" temp: Int
""" Count of I/O read requests sent to the device I/O drivers. These statistics may be cleared at any time. """ numReads: BigInt
""" Count of I/O writes requests sent to the device I/O drivers. These statistics may be cleared at any time. """ numWrites: BigInt
""" Number of unrecoverable errors reported by the device I/O drivers. Missing data due to unrecoverable array read errors is filled in on-the-fly using parity reconstruct (and we attempt to write this data back to the sector(s) which failed). Any unrecoverable write error results in disabling the disk. """ numErrors: BigInt
"""(KB) Total Size of the FS (Not present on Parity type drive)""" fsSize: BigInt
"""(KB) Free Size on the FS (Not present on Parity type drive)""" fsFree: BigInt
"""(KB) Used Size on the FS (Not present on Parity type drive)""" fsUsed: BigInt exportable: Boolean
"""Type of Disk - used to differentiate Cache / Flash / Array / Parity""" type: ArrayDiskType!
"""(%) Disk space left to warn""" warning: Int
"""(%) Disk space left for critical""" critical: Int
"""File system type for the disk""" fsType: String
"""User comment on disk""" comment: String
"""File format (ex MBR: 4KiB-aligned)""" format: String
"""ata | nvme | usb | (others)""" transport: String color: ArrayDiskFsColor
"""Whether the disk is currently spinning""" isSpinning: Boolean }
interface Node { id: PrefixedID! }
""" The `BigInt` scalar type represents non-fractional signed whole numeric values. """ scalar BigInt
enum ArrayDiskStatus { DISK_NP DISK_OK DISK_NP_MISSING DISK_INVALID DISK_WRONG DISK_DSBL DISK_NP_DSBL DISK_DSBL_NEW DISK_NEW }
enum ArrayDiskType { DATA PARITY FLASH CACHE }
enum ArrayDiskFsColor { GREEN_ON GREEN_BLINK BLUE_ON BLUE_BLINK YELLOW_ON YELLOW_BLINK RED_ON RED_OFF GREY_OFF }
type UnraidArray implements Node { id: PrefixedID!
"""Current array state""" state: ArrayState!
"""Current array capacity""" capacity: ArrayCapacity!
"""Current boot disk""" boot: ArrayDisk
"""Parity disks in the current array""" parities: [ArrayDisk!]!
"""Current parity check status""" parityCheckStatus: ParityCheck!
"""Data disks in the current array""" disks: [ArrayDisk!]!
"""Caches in the current array""" caches: [ArrayDisk!]! }
enum ArrayState { STARTED STOPPED NEW_ARRAY RECON_DISK DISABLE_DISK SWAP_DSBL INVALID_EXPANSION PARITY_NOT_BIGGEST TOO_MANY_MISSING_DISKS NEW_DISK_TOO_SMALL NO_DATA_DISKS }
type Share implements Node { id: PrefixedID!
"""Display name""" name: String
"""(KB) Free space""" free: BigInt
"""(KB) Used Size""" used: BigInt
"""(KB) Total size""" size: BigInt
"""Disks that are included in this share""" include: [String!]
"""Disks that are excluded from this share""" exclude: [String!]
"""Is this share cached""" cache: Boolean
"""Original name""" nameOrig: String
"""User comment""" comment: String
"""Allocator""" allocator: String
"""Split level""" splitLevel: String
"""Floor""" floor: String
"""COW""" cow: String
"""Color""" color: String
"""LUKS status""" luksStatus: String }
type DiskPartition { """The name of the partition""" name: String!
"""The filesystem type of the partition""" fsType: DiskFsType!
"""The size of the partition in bytes""" size: Float! }
"""The type of filesystem on the disk partition""" enum DiskFsType { XFS BTRFS VFAT ZFS EXT4 NTFS }
type Disk implements Node { id: PrefixedID!
"""The device path of the disk (e.g. /dev/sdb)""" device: String!
"""The type of disk (e.g. SSD, HDD)""" type: String!
"""The model name of the disk""" name: String!
"""The manufacturer of the disk""" ve
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.
**⚠️ DEVELOPER REFERENCE ONLY** — This file documents the raw GraphQL API schema for development and maintenance purposes (adding…
**⚠️ DEVELOPER REFERENCE ONLY** — This file documents raw GraphQL endpoints for development purposes. For MCP tool usage, use…
All operations use: `unraid(action="<domain>", subaction="<operation>", [params])`
**Error:** `CredentialsNotConfiguredError` or message containing `~/.unraid-mcp/.env`