TrueNAS MCP
The official TrueNAS MCP server: ask about pools, snapshots, virtual machines and apps in plain language.
- 117 ★ on the repository
- Last commit
- GPL-3.0
Broad access
Why this level
- An admin API key can change storage, virtual machines and services.
- Write operations are irreversible without snapshots and backups.
Install
- Works in
Manual install
Download the archive for your platform from the releases page with `checksums.txt`, verify the hash and put the `truenas-mcp` binary on `PATH`. Create an API key in TrueNAS and add the server to the client config with `--truenas-url`, `--api-key` and `--api-user`. For writes, ask for dry-run first.
Access and checks
How we reviewBroad accessThe tool can change data, run commands or handle secrets.
- An admin API key can change storage, virtual machines and services.
- Write operations are irreversible without snapshots and backups.
This is third-party code. Review the repository files before installing.
What it does
TrueNAS MCP connects an agent to the TrueNAS storage API. The agent reads state and metrics, looks at pools, datasets, snapshots and SMB and NFS shares, and works with virtual machines, directory services (Active Directory, LDAP, FreeIPA) and the app catalog. Write operations can first run in a dry-run mode with no changes. Long actions such as updates and pool scrubs come with task tracking. It is a single binary on your computer that connects to TrueNAS over a secure WebSocket and talks to the client over stdio. TrueNAS 25.04 or newer is required.
Who it is for. TrueNAS administrators who want to ask an agent about array health, snapshots and apps instead of clicking through the web interface.
Good fit when
- In the morning you want a quick look for alerts or pool degradation.
- Before an update you want a preview of changes in dry-run mode.
- You need to find datasets whose snapshots keep growing.
- An app from the catalog is installed with storage set up under the agent's guidance.
Not a fit when
- TrueNAS 24.10 or older is installed: the server only works with the new JSON-RPC API.
- Writes to the array cannot be left to an agent even with confirmation.
- A production system needs a stable interface: the project is labeled a research preview.
Example request
Show pool health and recent alerts, then list the snapshots that use the most space.MCP
- Transport
- stdio
- Authentication
- API key
Environment variables
TRUENAS_URLrequired- TrueNAS server address
TRUENAS_API_KEYrequired, secret- TrueNAS API key
TRUENAS_API_USERrequired- User who owns the key
Limitations
The project is labeled a research preview and the authors do not recommend it for production; interfaces may change. The server supports only TrueNAS 25.04 and newer, older versions fail the handshake. It needs an API key and the name of the user who owns it, and the README suggests an admin, so the key carries broad rights: limit it and keep it out of repositories. TrueNAS uses a self-signed certificate by default, so set a `TRUENAS_TLS_CA` file for verification. There is no prebuilt archive for Intel Macs; build from source with `make build`.
How to disable. Remove the `truenas` entry from the MCP client configuration and the `truenas-mcp` binary. Revoke the key in TrueNAS under API Keys.
FAQ
Which TrueNAS versions are required?
25.04 and newer. The server uses JSON-RPC at `/api/current` and `auth.login_ex`, with no fallback to the legacy protocol.
Where do I get a key?
In the web interface: System Settings, then API Keys, then Add. Note the user who owns the key; it goes into `--api-user`.
How do I connect Claude Code?
Add the `truenas-mcp` server with address, key and user arguments or with `TRUENAS_URL`, `TRUENAS_API_KEY`, `TRUENAS_API_USER`. Then restart the client.
What about the self-signed certificate?
Verification is on by default. Export the TrueNAS certificate and set its path in `TRUENAS_TLS_CA`.
Can I preview changes first?
Yes, write operations have a dry-run mode that shows what would be done without changing the system.
Discussion
No questions or reviews yet.
Related
MCP serversAn MCP server built into the Netdata agent: metrics, logs, alerts and live process, service and container data for an AI assistant
Official Cloudflare MCP server: the agent drives the whole Cloudflare API by searching the spec and running code
MCP servers for Unraid in Python and Rust: array state, Docker, virtual machines and telemetry over the GraphQL API
MCP server for a pfSense firewall via its REST API: 332 tools, confirmation for risky actions and a revision to roll back to
The official Prometheus MCP server: PromQL queries, metrics, rules and alerts plus built-in runbooks for troubleshooting.
An MCP server for Linux diagnostics: an AI client reads services, logs and network on local and remote hosts, read-only
Comparison with similar tools
Cards that share the main search query, and how they differ.
| Tool | Official | Authentication | Repository stars | Main difference |
|---|---|---|---|---|
| TrueNAS MCP (this card) | yes | API key | 117 | |
| UniFi MCP server | no | API key | 351 | manages UniFi networks; TrueNAS MCP works with storage, snapshots and virtual machines |
| ProxmoxMCP-Plus | no | key is optional | 649 | works with the Proxmox hypervisor; TrueNAS MCP targets TrueNAS arrays and apps |
README in short
The README covers building, installing on macOS, Linux and Windows, client setup, dry-run mode, task tracking and a list of safety controls including output redaction.