mirror of https://github.com/jmagar/unraid-mcp.git synced 2026-03-23 12:39:24 -07:00

Files

Jacob Magar 3888b9cb4a fix: address markdown lint and doc accuracy issues (threads 6-13)

Thread 6: Add python language specifier to .claude-plugin/README.md code fence
Thread 7: Fix MD022/MD031 spacing in docs/MARKETPLACE.md
Thread 8: Blank line before Destructive Actions heading in README.md
Thread 9: Move H1 to first line in skills/unraid/references/api-reference.md
Thread 10+11+12: Rewrite quick-reference.md:
  - Fix MD022/MD031 (blank lines around headings/fences)
  - Add python language specifiers to all code fences
  - Fix disk/logs params: path/lines → log_path/tail_lines
  - Add path param to live/log_tail example
  - Remove invalid notification/unread subaction
  - Fix notification/list filter= → list_type=
Thread 13: Add python/text language specifiers to troubleshooting.md fences
Thread 14: Update test-tools.sh header comment (in separate commit)
Also: Remove 'connect' from README system subactions table (it was removed from
the tool in previous commit), fix notification 'unread' → 'mark_unread' in table

2026-03-16 10:01:25 -04:00

marketplace.json

fix: address all 17 PR review comments

2026-03-16 02:58:54 -04:00

plugin.json

refactor(tools)!: consolidate 15 individual tools into single unified unraid tool

2026-03-16 02:29:57 -04:00

README.md

fix: address markdown lint and doc accuracy issues (threads 6-13)

2026-03-16 10:01:25 -04:00

README.md

Unraid MCP Marketplace

This directory contains the Claude Code marketplace configuration for the Unraid MCP server and skills.

Installation

From GitHub (Recommended)

# Add the marketplace
/plugin marketplace add jmagar/unraid-mcp

# Install the Unraid skill
/plugin install unraid @unraid-mcp

From Local Path (Development)

# Add local marketplace
/plugin marketplace add /path/to/unraid-mcp

# Install the plugin
/plugin install unraid @unraid-mcp

Available Plugins

unraid

Query and monitor Unraid servers via GraphQL API - array status, disk health, containers, VMs, system monitoring.

Features:

1 consolidated unraid tool with ~108 actions across 15 domains
Real-time live subscriptions (CPU, memory, logs, array state, UPS)
Disk health and temperature monitoring
Docker container management
VM status and control
Log file access
Network share information
Notification management
Plugin, rclone, API key, and OIDC management

Version: 1.0.0 Category: Infrastructure Tags: unraid, monitoring, homelab, graphql, docker, virtualization

Configuration

After installation, run setup to configure credentials interactively:

unraid(action="health", subaction="setup")

Credentials are stored at ~/.unraid-mcp/.env automatically.

Getting an API Key:

Open Unraid WebUI
Go to Settings → Management Access → API Keys
Click "Create" and select "Viewer" role (or appropriate roles for mutations)
Copy the generated API key

Documentation

Plugin Documentation: See skills/unraid/README.md
MCP Server Documentation: See root README.md
API Reference: See skills/unraid/references/

Support

Issues: https://github.com/jmagar/unraid-mcp/issues
Repository: https://github.com/jmagar/unraid-mcp