unraidclaw
v0.1.13
Published
OpenClaw plugin to manage your Unraid server — Docker, VMs, array, shares, system, and more.
Readme
unraidclaw
OpenClaw plugin to manage your Unraid server through AI agents — Docker, VMs, array, shares, system, notifications, and more, with permission control.
This is the OpenClaw plugin for UnraidClaw. It exposes 44 tools to any AI agent running on OpenClaw, letting it monitor and manage your Unraid server. The plugin talks to the UnraidClaw gateway (a permission-enforcing REST API) running on your Unraid box.
Prerequisites
- The UnraidClaw plugin installed on your Unraid server — install it from the Unraid Community Apps store, or see the main repo. It runs the gateway on port
9876(HTTPS). - An UnraidClaw API key — generate one on the Settings → UnraidClaw page in the Unraid WebGUI.
- OpenClaw installed (
openclaw --version).
Install
npm pack unraidclaw && openclaw plugins install unraidclaw-*.tgz && rm unraidclaw-*.tgzTo update to the latest version:
rm -rf ~/.openclaw/extensions/unraidclaw && npm pack unraidclaw && openclaw plugins install unraidclaw-*.tgz && rm unraidclaw-*.tgzConfigure
Edit ~/.openclaw/openclaw.json.
Single server:
{
"plugins": {
"allow": ["unraidclaw"],
"entries": {
"unraidclaw": {
"config": {
"serverUrl": "https://YOUR_UNRAID_IP:9876",
"apiKey": "YOUR_API_KEY",
"tlsSkipVerify": true
}
}
}
}
}Multiple servers:
{
"plugins": {
"allow": ["unraidclaw"],
"entries": {
"unraidclaw": {
"config": {
"servers": [
{ "name": "home", "serverUrl": "https://192.168.1.100:9876", "apiKey": "...", "tlsSkipVerify": true, "default": true },
{ "name": "work", "serverUrl": "https://10.0.0.50:9876", "apiKey": "..." }
]
}
}
}
}
}With multi-server config, every tool accepts an optional server parameter (e.g. unraid_docker_list(server: "work")); the default server is used when it's omitted.
Set tlsSkipVerify: true when using UnraidClaw's auto-generated self-signed certificate.
Keeping the API key out of the config file
You don't have to hard-code the key in openclaw.json. Two options:
Environment variable — OpenClaw expands ${VAR} references at config-load time:
"apiKey": "${UNRAID_API_KEY}"Provider-backed secret (SecretRef) — point apiKey at one of your configured secret providers; OpenClaw resolves it before the plugin loads, so the plugin only ever sees the resolved string:
"apiKey": { "source": "file", "provider": "default", "id": "/unraidclaw_key" }source is one of file, env, or exec; provider names a provider from your secrets.providers config; id is the lookup key. Both forms also work per-server on servers[].apiKey. (Requires unraidclaw 0.1.12+.)
Usage
Once installed and configured, just ask your agent:
- "List all running Docker containers"
- "Stop the plex container"
- "What's the array status?"
- "Show me disk temperatures"
- "Create a new nginx container with port 8080"
- "Check parity status"
- "Reboot the server"
Tools
44 tools across 11 categories:
| Category | Tools |
|----------|-------|
| Health | unraid_health_check |
| Docker | unraid_docker_list, unraid_docker_inspect, unraid_docker_logs, unraid_docker_create, unraid_docker_start, unraid_docker_stop, unraid_docker_restart, unraid_docker_pause, unraid_docker_unpause, unraid_docker_remove |
| VMs | unraid_vm_list, unraid_vm_inspect, unraid_vm_start, unraid_vm_stop, unraid_vm_pause, unraid_vm_resume, unraid_vm_force_stop, unraid_vm_reboot |
| Array | unraid_array_status, unraid_array_start, unraid_array_stop, unraid_parity_status, unraid_parity_start, unraid_parity_pause, unraid_parity_resume, unraid_parity_cancel |
| Disks | unraid_disk_list, unraid_disk_details |
| Shares | unraid_share_list, unraid_share_details, unraid_share_update |
| System | unraid_system_info, unraid_system_metrics, unraid_service_list, unraid_system_reboot, unraid_system_shutdown |
| Notifications | unraid_notification_list, unraid_notification_create, unraid_notification_archive, unraid_notification_delete |
| Network | unraid_network_info |
| Users | unraid_user_me |
| Logs | unraid_syslog |
Every tool is gated by a 22-key resource:action permission matrix configured from the Unraid WebGUI, so you control exactly what agents can do.
Links
License
MIT
