mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-02 08:14:43 -08:00
37e9424a5c
Comprehensive fixes across Python code, shell scripts, and documentation addressing all remaining MEDIUM and LOW priority review comments. Python Code Fixes (27 fixes): - tools/info.py: Simplified dispatch with lookup tables, defensive guards, CPU fallback formatting, !s conversion flags, module-level sync assertion - tools/docker.py: Case-insensitive container ID regex, keyword-only confirm, module-level ALL_ACTIONS constant - tools/virtualization.py: Normalized single-VM dict responses, unified list/details queries - core/client.py: Fixed HTTP client singleton race condition, compound key substring matching for sensitive data redaction - subscriptions/: Extracted SSL context creation to shared helper in utils.py, replaced deprecated ssl._create_unverified_context API - tools/array.py: Renamed parity_history to parity_status, hoisted ALL_ACTIONS - tools/storage.py: Fixed dict(None) risks, temperature 0 falsiness bug - tools/notifications.py, keys.py, rclone.py: Fixed dict(None) TypeError risks - tests/: Fixed generator type annotations, added coverage for compound keys Shell Script Fixes (13 fixes): - dashboard.sh: Dynamic server discovery, conditional debug output, null-safe jq, notification count guard order, removed unused variables - unraid-query.sh: Proper JSON escaping via jq, --ignore-errors and --insecure CLI flags, TLS verification now on by default - validate-marketplace.sh: Removed unused YELLOW variable, defensive jq, simplified repository URL output Documentation Fixes (24+ fixes): - Version consistency: Updated all references to v0.2.0 across pyproject.toml, plugin.json, marketplace.json, MARKETPLACE.md, __init__.py, README files - Tool count updates: Changed all "26 tools" references to "10 tools, 90 actions" - Markdown lint: Fixed MD022, MD031, MD047 issues across multiple files - Research docs: Fixed auth headers, removed web artifacts, corrected stale info - Skills docs: Fixed query examples, endpoint counts, env var references All 227 tests pass, ruff and ty checks clean.
72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
# Unraid MCP Marketplace
|
|
|
|
This directory contains the Claude Code marketplace configuration for the Unraid MCP server and skills.
|
|
|
|
## Installation
|
|
|
|
### From GitHub (Recommended)
|
|
|
|
```bash
|
|
# Add the marketplace
|
|
/plugin marketplace add jmagar/unraid-mcp
|
|
|
|
# Install the Unraid skill
|
|
/plugin install unraid @unraid-mcp
|
|
```
|
|
|
|
### From Local Path (Development)
|
|
|
|
```bash
|
|
# 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:**
|
|
- 10 tools with 90 actions (queries and mutations)
|
|
- Real-time system metrics
|
|
- Disk health and temperature monitoring
|
|
- Docker container management
|
|
- VM status and control
|
|
- Log file access
|
|
- Network share information
|
|
- Notification management
|
|
|
|
**Version:** 0.2.0
|
|
**Category:** Infrastructure
|
|
**Tags:** unraid, monitoring, homelab, graphql, docker, virtualization
|
|
|
|
## Configuration
|
|
|
|
After installation, configure your Unraid server credentials:
|
|
|
|
```bash
|
|
export UNRAID_API_URL="https://your-unraid-server/graphql"
|
|
export UNRAID_API_KEY="your-api-key"
|
|
```
|
|
|
|
**Getting an API Key:**
|
|
1. Open Unraid WebUI
|
|
2. Go to Settings → Management Access → API Keys
|
|
3. Click "Create" and select "Viewer" role
|
|
4. 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
|