TrueNAS Core MCP

TrueNAS Core MCP

An MCP server for interacting with TrueNAS Core.

6
Stars
3
Forks
1
Releases

Overview

TrueNAS MCP Server is a production-ready Model Context Protocol (MCP) server designed to interact with TrueNAS Core systems. It enables natural language control and automation of storage management through Claude or other MCP-compatible clients. The server exposes core capabilities for user management, storage management (pools, datasets, volumes with ZFS support), file sharing (SMB, NFS, iSCSI), snapshot management, and system monitoring (health, pool status, resource usage). It provides enterprise-grade features including type-safe operations via Pydantic models, comprehensive error handling with actionable guidance, and production logging with configurable levels. Additional resilience comes from connection pooling with retry logic and built-in rate limiting to prevent API abuse. The software supports flexible, environment-based configuration and can be installed via uvx for quick start or traditional pip/pipx installations. Configuration examples demonstrate required TRUENAS_URL and TRUENAS_API_KEY, optional SSL verification, log level, environment, and toggles for destructive operations and debugging tools. The repository also documents architecture and usage patterns with programmatic examples for direct HTTP client interactions.

Details

Owner
vespo92
Language
Python
License
MIT License
Updated
2025-12-07

Features

User Management

Create, update, delete users and manage permissions

Storage Management

Manage pools, datasets, volumes with full ZFS support

File Sharing

Configure SMB, NFS, and iSCSI shares

Snapshot Management

Create, delete, rollback snapshots with automation

System Monitoring

Check system health, pool status, and resource usage

Type-Safe Operations

Full Pydantic models for request/response validation

Comprehensive Error Handling

Detailed error messages and recovery guidance

Production Logging

Structured logging with configurable levels

Tags

TrueNASMCPTrueNAS Corestorage managementuser managementfile sharingsnapshotsZFSSMBNFSiSCSIClaudePythonPydanticAPI