Update documentation for app installation wizard and catalog features
Add comprehensive documentation for the new guided app installation wizard and catalog search capabilities. Changes: - README: Update Applications section to mention catalog search and guided installation with storage setup - examples.md: Add extensive examples for: * App catalog search and browsing * Guided installation workflow with multi-step wizard * Storage requirement planning and dataset creation * App management operations (delete, upgrade) - full-features.md: Document new tools: * search_app_catalog - Search apps by name/category/keyword * get_app_catalog_details - Get app details, storage hints, and README * install_app - Complete wizard guidance with 8-step process * delete_app - Safe removal preserving data in host-path datasets The guided installation wizard automatically: - Queries available pools - Plans dataset structure - Creates missing datasets - Validates configuration - Tracks installation progress Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Sonnet 4.5
parent
42b8db9d85
commit
3b39f46e1f
@@ -38,7 +38,7 @@ TrueNAS MCP provides comprehensive management capabilities through natural langu
|
||||
- 🔐 **Directory Services** - Active Directory, LDAP, FreeIPA integration and health monitoring
|
||||
- 📈 **Capacity Planning** - Utilization analysis and trend projections
|
||||
- 🔄 **Maintenance** - System updates, boot environments, pool scrubs
|
||||
- 📦 **Applications** - App status and upgrades
|
||||
- 📦 **Applications** - Catalog search, guided installation with storage setup, app management and upgrades
|
||||
- ⚙️ **Tasks** - Long-running operation tracking
|
||||
|
||||
### Key Capabilities
|
||||
|
||||
@@ -60,9 +60,31 @@ This document provides example natural language queries you can use with TrueNAS
|
||||
|
||||
## Applications
|
||||
|
||||
### Installed Apps
|
||||
- "What apps are installed and running?"
|
||||
- "Are there any app updates available?"
|
||||
- "Upgrade the plex app to the latest version"
|
||||
- "Delete the jellyfin app (show me what will happen first)"
|
||||
- "Remove the plex app and its container images"
|
||||
|
||||
### App Catalog & Installation
|
||||
- "Search for media server apps in the catalog"
|
||||
- "What apps are available for home automation?"
|
||||
- "Tell me about the Plex app"
|
||||
- "Show me details about Nextcloud"
|
||||
- "What storage does Jellyfin need?"
|
||||
- "Install Plex on my system"
|
||||
- *This will trigger a multi-step guided wizard that:*
|
||||
- *Searches catalog for the app*
|
||||
- *Gets app details and storage requirements*
|
||||
- *Queries available pools*
|
||||
- *Proposes dataset structure (e.g., tank/apps/plex/config, tank/apps/plex/data)*
|
||||
- *Creates missing datasets with appropriate quotas*
|
||||
- *Validates configuration*
|
||||
- *Previews installation with dry-run*
|
||||
- *Executes installation and tracks progress*
|
||||
- "Set up Nextcloud with 1TB storage on my tank pool"
|
||||
- "Install Jellyfin using my existing media dataset"
|
||||
|
||||
## Directory Services
|
||||
|
||||
|
||||
@@ -49,6 +49,15 @@ This document provides a comprehensive list of all available MCP tools for TrueN
|
||||
|
||||
### Applications
|
||||
- **query_apps** - List installed applications with status and available updates
|
||||
- **search_app_catalog** - Search TrueNAS app catalog by name, category, or keyword
|
||||
- Search across all catalog trains (stable, enterprise, community)
|
||||
- Filter by category (media, productivity, database, etc.)
|
||||
- Returns app information with versions and installation status
|
||||
- **get_app_catalog_details** - Get detailed information about a specific app
|
||||
- Returns README documentation and setup instructions
|
||||
- Shows version info, categories, and maintainers
|
||||
- Provides storage volume hints (detected from README)
|
||||
- Recommends dataset layout: /mnt/<pool>/apps/<appname>/<volume>
|
||||
|
||||
## Capacity Planning and Analysis
|
||||
|
||||
@@ -100,6 +109,31 @@ This document provides a comprehensive list of all available MCP tools for TrueN
|
||||
- Dry-run mode to preview with mount examples
|
||||
|
||||
### Application Management
|
||||
- **install_app** - Install applications from the catalog with guided storage setup
|
||||
- Multi-step wizard guides through app installation process
|
||||
- ALWAYS uses host-path volumes (NEVER ix-volumes)
|
||||
- Enforces structured dataset layout: /mnt/<pool>/apps/<appname>/<volume>
|
||||
- Validates app instance names (lowercase, alphanumeric, hyphens)
|
||||
- Verifies datasets exist before installation
|
||||
- Supports dry-run mode to preview installation
|
||||
- Returns task ID for tracking installation progress
|
||||
- Includes comprehensive wizard guidance:
|
||||
- Step 1: Search and select app from catalog
|
||||
- Step 2: Understand app storage requirements
|
||||
- Step 3: Plan storage layout with pool selection
|
||||
- Step 4: Create missing datasets
|
||||
- Step 5: Validate app instance name
|
||||
- Step 6: Build storage configuration
|
||||
- Step 7: Preview with dry-run
|
||||
- Step 8: Execute installation
|
||||
|
||||
- **delete_app** - Remove installed applications
|
||||
- IMPORTANT: Host-path datasets are NOT deleted (preserved for data safety)
|
||||
- Data remains in original locations for manual cleanup
|
||||
- Optional removal of container images
|
||||
- Supports dry-run mode to preview deletion
|
||||
- Returns task ID for tracking deletion progress
|
||||
|
||||
- **upgrade_app** - Upgrade an application to a newer version with optional snapshot backup
|
||||
- Supports dry-run mode to preview changes before execution
|
||||
- Returns a task ID for tracking long-running operations
|
||||
|
||||
Reference in New Issue
Block a user