Skip to content

Add TrueNAS Core MCP Server #2061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vespo92
Copy link

@vespo92 vespo92 commented Jun 10, 2025

Add TrueNAS Core MCP Server

Description

Adds official TrueNAS Core MCP server to enable NAS management through LLM interfaces.

Server Details

Server: https://github.com/vespo92/TrueNasCoreMCP

Motivation and Context

This MCP server enables LLMs to interact with TrueNAS Core systems, allowing users to manage their NAS through natural language. Users can query system status, manage storage pools and datasets, create snapshots, and configure SMB shares directly from Claude Desktop or other MCP-compatible clients. The server provides a secure, API-based integration that makes NAS administration more accessible and efficient.

How Has This Been Tested?

  • ✅ Tested with Claude Desktop on Windows 10/11
  • ✅ Verified with TrueNAS Core 13.0-U6.1
  • ✅ Tested all core functions: user management, pool operations, dataset creation, SMB shares
  • ✅ Connection test script included for easy verification
  • ✅ Error handling tested with invalid credentials and network failures

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Protocol Documentation
  • My changes follow MCP security best practices
  • I have updated the server's README accordingly
  • I have tested this with an LLM client
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have documented all environment variables and configuration options

Additional context

This server is designed specifically for TrueNAS Core (not SCALE) and uses the official TrueNAS API v2.0. It includes:

  • Automated setup scripts for Windows and Unix-like systems
  • Comprehensive documentation with quick-start guide
  • Security-first design with API key authentication
  • No external dependencies beyond Python standard library and essential packages
  • MIT licensed for maximum compatibility

Add TrueNAS Core (community created)
@vespo92 vespo92 changed the title Update README.md Add TrueNAS Core MCP Server Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant