forked from HomeLab/unraid-mcp
184b8aca1c
**Critical Fixes (7 issues):**
- Fix GraphQL schema field names in users tool (role→roles, remove email)
- Fix GraphQL mutation signatures (addUserInput, deleteUser input)
- Fix dict(None) TypeError guards in users tool (use `or {}` pattern)
- Fix FastAPI version constraint (0.116.1→0.115.0)
- Fix WebSocket SSL context handling (support CA bundles, bool, and None)
- Fix critical disk threshold treated as warning (split counters)
**High Priority Fixes (11 issues):**
- Fix Docker update/remove action response field mapping
- Fix path traversal vulnerability in log validation (normalize paths)
- Fix deleteApiKeys validation (check response before success)
- Fix rclone create_remote validation (check response)
- Fix keys input_data type annotation (dict[str, Any])
- Fix VM domain/domains fallback restoration
**Changes by file:**
- unraid_mcp/tools/docker.py: Response field mapping
- unraid_mcp/tools/info.py: Split critical/warning counters
- unraid_mcp/tools/storage.py: Path normalization for traversal protection
- unraid_mcp/tools/users.py: GraphQL schema + null handling
- unraid_mcp/tools/keys.py: Validation + type annotations
- unraid_mcp/tools/rclone.py: Response validation
- unraid_mcp/tools/virtualization.py: Domain fallback
- unraid_mcp/subscriptions/manager.py: SSL context creation
- pyproject.toml: FastAPI version fix
- tests/*: New tests for all fixes
**Review threads resolved:**
PRRT_kwDOO6Hdxs5uu70L, PRRT_kwDOO6Hdxs5uu70O, PRRT_kwDOO6Hdxs5uu70V,
PRRT_kwDOO6Hdxs5uu70e, PRRT_kwDOO6Hdxs5uu70i, PRRT_kwDOO6Hdxs5uu7zn,
PRRT_kwDOO6Hdxs5uu7z_, PRRT_kwDOO6Hdxs5uu7sI, PRRT_kwDOO6Hdxs5uu7sJ,
PRRT_kwDOO6Hdxs5uu7sK, PRRT_kwDOO6Hdxs5uu7Tk, PRRT_kwDOO6Hdxs5uu7Tn,
PRRT_kwDOO6Hdxs5uu7Tr, PRRT_kwDOO6Hdxs5uu7Ts, PRRT_kwDOO6Hdxs5uu7Tu,
PRRT_kwDOO6Hdxs5uu7Tv, PRRT_kwDOO6Hdxs5uu7Tw, PRRT_kwDOO6Hdxs5uu7Tx
All tests passing.
Co-authored-by: docker-fixer <agent@pr-fixes>
Co-authored-by: info-fixer <agent@pr-fixes>
Co-authored-by: storage-fixer <agent@pr-fixes>
Co-authored-by: users-fixer <agent@pr-fixes>
Co-authored-by: config-fixer <agent@pr-fixes>
Co-authored-by: websocket-fixer <agent@pr-fixes>
Co-authored-by: keys-rclone-fixer <agent@pr-fixes>
Co-authored-by: vm-fixer <agent@pr-fixes>
71 lines
1.6 KiB
Markdown
71 lines
1.6 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:**
|
|
- 27 read-only API endpoints
|
|
- 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:** 1.1.0
|
|
**Category:** Infrastructure
|
|
**Tags:** unraid, monitoring, homelab, graphql, docker, virtualization
|
|
|
|
## Configuration
|
|
|
|
After installation, configure your Unraid server credentials:
|
|
|
|
```bash
|
|
export UNRAID_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
|