mirror of https://github.com/jmagar/unraid-mcp.git synced 2026-03-23 04:29:17 -07:00

Files

Jacob Magar cc24f1ec62 feat: add API key bearer token authentication

- ApiKeyVerifier(TokenVerifier) — validates Authorization: Bearer <key>
  against UNRAID_MCP_API_KEY; guards against empty-key bypass
- _build_auth() replaces module-level _build_google_auth() call:
  returns MultiAuth(server=google, verifiers=[api_key]) when both set,
  GoogleProvider alone, ApiKeyVerifier alone, or None
- settings.py: add UNRAID_MCP_API_KEY + is_api_key_auth_configured()
  + api_key_auth_enabled in get_config_summary()
- run_server(): improved auth status logging for all three states
- tests/test_api_key_auth.py: 9 tests covering verifier + _build_auth
- .env.example: add UNRAID_MCP_API_KEY section
- docs/GOOGLE_OAUTH.md: add API Key section
- README.md / CLAUDE.md: rename section, document both auth methods
- Fix pre-existing: test_health.py patched cache_middleware/error_middleware
  now match renamed _cache_middleware/_error_middleware in server.py

2026-03-16 11:11:38 -04:00

4.2 KiB

Raw Blame History

Unraid MCP — Quick Reference

All operations use: unraid(action="<domain>", subaction="<operation>", [params])

Most Common Operations

Health & Status

unraid(action="health",  subaction="setup")            # First-time credential setup
unraid(action="health",  subaction="check")            # Full health check
unraid(action="health",  subaction="test_connection")  # Quick connectivity test
unraid(action="system",  subaction="overview")         # Complete server summary
unraid(action="system",  subaction="metrics")          # CPU / RAM / I/O usage
unraid(action="system",  subaction="online")           # Online status

Array & Disks

unraid(action="system",  subaction="array")             # Array status overview
unraid(action="disk",    subaction="disks")             # All disks with temps & health
unraid(action="array",   subaction="parity_status")     # Current parity check
unraid(action="array",   subaction="parity_history")    # Past parity results
unraid(action="array",   subaction="parity_start")      # Start parity check
unraid(action="array",   subaction="stop_array",  confirm=True)   # ⚠️ Stop array

Logs

unraid(action="disk", subaction="log_files")                                          # List available logs
unraid(action="disk", subaction="logs", log_path="/var/log/syslog", tail_lines=50)    # Read syslog
unraid(action="live", subaction="log_tail", path="/var/log/syslog")                   # Live tail

Docker Containers

unraid(action="docker", subaction="list")
unraid(action="docker", subaction="details",  container_id="plex")
unraid(action="docker", subaction="start",    container_id="nginx")
unraid(action="docker", subaction="stop",     container_id="nginx")
unraid(action="docker", subaction="restart",  container_id="sonarr")
unraid(action="docker", subaction="networks")

Virtual Machines

unraid(action="vm", subaction="list")
unraid(action="vm", subaction="details",    vm_id="<id>")
unraid(action="vm", subaction="start",      vm_id="<id>")
unraid(action="vm", subaction="stop",       vm_id="<id>")
unraid(action="vm", subaction="reboot",     vm_id="<id>")
unraid(action="vm", subaction="force_stop", vm_id="<id>", confirm=True)   # ⚠️

Notifications

unraid(action="notification", subaction="overview")
unraid(action="notification", subaction="list",    list_type="UNREAD", limit=10)
unraid(action="notification", subaction="archive", notification_id="<id>")
unraid(action="notification", subaction="create",  title="Test", subject="Subject",
                                                   description="Body", importance="INFO")

API Keys

unraid(action="key", subaction="list")
unraid(action="key", subaction="create", name="my-key", roles=["viewer"])
unraid(action="key", subaction="delete", key_id="<id>", confirm=True)   # ⚠️

Plugins

unraid(action="plugin", subaction="list")
unraid(action="plugin", subaction="add",    names=["community.applications"])
unraid(action="plugin", subaction="remove", names=["old.plugin"], confirm=True)   # ⚠️

rclone

unraid(action="rclone", subaction="list_remotes")
unraid(action="rclone", subaction="delete_remote", name="<remote>", confirm=True)   # ⚠️

Live Subscriptions (real-time)

unraid(action="live", subaction="cpu")
unraid(action="live", subaction="memory")
unraid(action="live", subaction="parity_progress")
unraid(action="live", subaction="log_tail")
unraid(action="live", subaction="notification_feed")
unraid(action="live", subaction="ups_status")

Returns {"status": "connecting"} on first call — retry momentarily.

Domain → action= Mapping

Old tool name (pre-v1.0)	New `action=`
`unraid_info`	`system`
`unraid_health`	`health`
`unraid_array`	`array`
`unraid_storage`	`disk`
`unraid_docker`	`docker`
`unraid_vm`	`vm`
`unraid_notifications`	`notification`
`unraid_keys`	`key`
`unraid_plugins`	`plugin`
`unraid_rclone`	`rclone`
`unraid_settings`	`setting`
`unraid_customization`	`customization`
`unraid_oidc`	`oidc`
`unraid_users`	`user`
`unraid_live`	`live`

4.2 KiB Raw Blame History