feat: Add TrueNAS SCALE virtualization support with automatic variant detection #4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds comprehensive support for managing Apps, Incus instances (VMs and Containers), and Legacy VMs on TrueNAS SCALE. New tools: - AppTools: list_apps, get_app, get_app_config, start_app, stop_app, restart_app, redeploy_app, update_app_config - InstanceTools: list_instances, get_instance, start_instance, stop_instance, restart_instance, update_instance, list_instance_devices - LegacyVMTools: list_legacy_vms, get_legacy_vm, start_legacy_vm, stop_legacy_vm, restart_legacy_vm, update_legacy_vm, get_legacy_vm_status Key features: - Handles TrueNAS API quirks (plain string bodies for /virt/instance/start and /app/config endpoints) - Async operation polling for start/stop operations - Memory handling in bytes for Incus instances - Full Pydantic models for type safety 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Adds comprehensive tests for AppTools, InstanceTools, and LegacyVMTools that run against actual TrueNAS servers. Tests verify: - List operations for apps, instances, and legacy VMs - Get operations for individual resources - Proper error handling for nonexistent resources - API quirk handling (plain string body for /app/config) All 13 tests passing against TrueNAS SCALE 25.04 (lev-nas). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Update description to include TrueNAS SCALE support - Add Virtualization section to Features - Document all App, Instance, and Legacy VM tools - Update architecture diagram with new files - Add SCALE-specific usage examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add TrueNASVariant enum (CORE, SCALE, UNKNOWN) - Add detect_variant() method to client that queries /system/info - Falls back to checking /app endpoint if version string is ambiguous - Conditionally register tools based on detected variant: - Universal tools (users, storage, sharing, snapshots) on both - SCALE-only tools (apps, instances, vms) only on SCALE - Update README to clarify Core vs SCALE feature support 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @vespo92,
I've been using your TrueNAS MCP server and wanted to contribute back some enhancements that expand its scope to cover the full TrueNAS Community Edition ecosystem (both Core and SCALE) as I'm running Scale and particularly wanted it to cover apps/vms as well
Assuming you're interested in broadening this, I'm planning on continuing to add functionality, particularly around replication management and backups. Would love to hear your thoughts on the direction. Happy to make any adjustments based on your feedback!
What This PR Adds
SCALE Virtualization Tools (22 new tools)
Automatic Variant Detection
API Quirk Handling
post_raw()method to handle TrueNAS APIs that expect plain string bodies instead of JSON objects (e.g.,/app/config,/virt/instance/start)Testing
I've tested against SCALE 25.04 and 25.10