# Send Unraid to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "unraid",
    "name": "Unraid",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/jmagar/unraid",
    "canonicalUrl": "https://clawhub.ai/jmagar/unraid",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/unraid",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=unraid",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "README.md",
      "SKILL.md",
      "examples/disk-health.sh",
      "examples/read-logs.sh",
      "references/api-reference.md",
      "references/endpoints.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "unraid",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-10T12:00:27.524Z",
      "expiresAt": "2026-05-17T12:00:27.524Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=unraid",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=unraid",
        "contentDisposition": "attachment; filename=\"unraid-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "unraid"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/unraid"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/unraid",
    "downloadUrl": "https://openagent3.xyz/downloads/unraid",
    "agentUrl": "https://openagent3.xyz/skills/unraid/agent",
    "manifestUrl": "https://openagent3.xyz/skills/unraid/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/unraid/agent.md"
  }
}
```
## Documentation

### Unraid API Skill

Query and monitor Unraid servers using the GraphQL API. Access all 27 read-only endpoints for system monitoring, disk health, logs, containers, VMs, and more.

### Quick Start

Set your Unraid server credentials:

export UNRAID_URL="https://your-unraid-server/graphql"
export UNRAID_API_KEY="your-api-key"

Get API Key: Settings → Management Access → API Keys → Create (select "Viewer" role)

Use the helper script for any query:

./scripts/unraid-query.sh -q "{ online }"

Or run example scripts:

./scripts/dashboard.sh              # Complete multi-server dashboard
./examples/disk-health.sh           # Disk temperatures & health
./examples/read-logs.sh syslog 20   # Read system logs

### GraphQL API Structure

Unraid 7.2+ uses GraphQL (not REST). Key differences:

Single endpoint: /graphql for all queries
Request exactly what you need: Specify fields in query
Strongly typed: Use introspection to discover fields
No container logs: Docker container output logs not accessible

### Two Resources for Stats

info - Static hardware specs (CPU model, cores, OS version)
metrics - Real-time usage (CPU %, memory %, current load)

Always use metrics for monitoring, info for specifications.

### System Monitoring

Check if server is online:

./scripts/unraid-query.sh -q "{ online }"

Get CPU and memory usage:

./scripts/unraid-query.sh -q "{ metrics { cpu { percentTotal } memory { used total percentTotal } } }"

Complete dashboard:

./scripts/dashboard.sh

### Disk Management

Check disk health and temperatures:

./examples/disk-health.sh

Get array status:

./scripts/unraid-query.sh -q "{ array { state parityCheckStatus { status progress errors } } }"

List all physical disks (including cache/USB):

./scripts/unraid-query.sh -q "{ disks { name } }"

### Storage Shares

List network shares:

./scripts/unraid-query.sh -q "{ shares { name comment } }"

### Logs

List available logs:

./scripts/unraid-query.sh -q "{ logFiles { name size modifiedAt } }"

Read log content:

./examples/read-logs.sh syslog 20

### Containers & VMs

List Docker containers:

./scripts/unraid-query.sh -q "{ docker { containers { names image state status } } }"

List VMs:

./scripts/unraid-query.sh -q "{ vms { name state cpus memory } } }"

Note: Container output logs are NOT accessible via API. Use docker logs via SSH.

### Notifications

Get notification counts:

./scripts/unraid-query.sh -q "{ notifications { overview { unread { info warning alert total } } } }"

### Helper Script Usage

The scripts/unraid-query.sh helper supports:

# Basic usage
./scripts/unraid-query.sh -u URL -k API_KEY -q "QUERY"

# Use environment variables
export UNRAID_URL="https://unraid.local/graphql"
export UNRAID_API_KEY="your-key"
./scripts/unraid-query.sh -q "{ online }"

# Format options
-f json    # Raw JSON (default)
-f pretty  # Pretty-printed JSON
-f raw     # Just the data (no wrapper)

### Reference Files

For detailed documentation, consult:

references/endpoints.md - Complete list of all 27 API endpoints
references/troubleshooting.md - Common errors and solutions
references/api-reference.md - Detailed field documentation

### Helper Scripts

scripts/unraid-query.sh - Main GraphQL query tool
scripts/dashboard.sh - Automated multi-server inventory reporter

### Quick Command Reference

# System status
./scripts/unraid-query.sh -q "{ online metrics { cpu { percentTotal } } }"

# Disk health
./examples/disk-health.sh

# Array status
./scripts/unraid-query.sh -q "{ array { state } }"

# Read logs
./examples/read-logs.sh syslog 20

# Complete dashboard
./scripts/dashboard.sh

# List shares
./scripts/unraid-query.sh -q "{ shares { name } }"

# List containers
./scripts/unraid-query.sh -q "{ docker { containers { names state } } }"
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: jmagar
- Version: 1.0.1
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-10T12:00:27.524Z
- Expires at: 2026-05-17T12:00:27.524Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/unraid)
- [Send to Agent page](https://openagent3.xyz/skills/unraid/agent)
- [JSON manifest](https://openagent3.xyz/skills/unraid/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/unraid/agent.md)
- [Download page](https://openagent3.xyz/downloads/unraid)