Provides tools to manage TrueNAS instances, including disks, pools, apps, VMs, shares, and more.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type @ followed by the MCP server name and your instructions, e.g., "@TrueNAS MCP Show me the health of my storage pools"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
An MCP server that turns your TrueNAS (SCALE) instance into tools. Manage pools,
disks, datasets, apps, VMs and more from any MCP client. Built on FastMCP and the
official truenas_api_client websocket library.
Authenticated with a TrueNAS API key over a persistent websocket connection.
Targets TrueNAS 25.10 (pin: TS-25.10.3).
You need a TrueNAS instance and an API key (Account Settings > API Keys).
docker build -t truenas-mcp .
docker run -e TRUENAS_URI=wss://truenas.example.com/api/current \
-e TRUENAS_API_KEY=your-key \
truenas-mcpRelated MCP server: truenas-ws-mcp
name | default | notes |
| - | required, ws:// or wss:// websocket URL, e.g. |
| - | required, from TrueNAS API Keys |
| true | set false only over plain |
| INFO |
Values can come from a .env file in the working directory. API-key auth uses
auth.login_with_api_key over the persistent connection (TrueNAS 25.10 SCRAM -
no username needed).
By default the server talks stdio (one process per client). To expose it as an HTTP MCP endpoint behind a gateway (e.g. LiteLLM), set the FastMCP transport env vars - no code change required:
env | default |
|
|
|
|
|
|
|
|
Example - serve streamable-http on all interfaces:
FASTMCP_TRANSPORT=streamable-http FASTMCP_HOST=0.0.0.0 FASTMCP_PORT=8000 \
truenas-mcpsystem_info, list_pools, list_disks, list_datasets, list_apps,
list_vms, truenas_call (generic middleware escape hatch).
MIT
Create a ZFS dataset.
Inputs: name (required), dry_run. Returns: result
Create a ZFS snapshot.
Inputs: dataset (required), name, dry_run. Returns: result
Delete an installed app.
Inputs: app_name (required), dry_run, remove_images. Returns: result
Delete a ZFS dataset.
Inputs: name (required), dry_run, recursive. Returns: result
Delete a ZFS snapshot.
Inputs: name (required), dry_run. Returns: result
Dismiss a TrueNAS alert.
Inputs: alert_id (required). Returns: result
Get ZFS pool scrub status/schedules.
Inputs: pool_name. Returns: result
Install an app from the TrueNAS catalog.
Inputs: values (required), app_name (required), catalog_app (required), train, +2 more. Returns: result
List TrueNAS system alerts.
Inputs: no named parameters. Returns: result
List installed applications (k3s apps) with state and version.
Inputs: no named parameters. Returns: result
List boot environments (active, activated, kernel/initramfs).
Inputs: no named parameters. Returns: result
List ZFS datasets (name, mountpoint, used/available, quotas).
Inputs: path. Returns: result
List disks and their health fields (model, serial, size, SMART status).
Inputs: serial. Returns: result
List middleware jobs (long-running operations).
Inputs: state. Returns: result
List storage pools and their ZFS status (health, capacity, topology).
Inputs: name. Returns: result
List ZFS snapshots.
Inputs: dataset. Returns: result
List virtual machines with their current status.
Inputs: no named parameters. Returns: result
Restore a dismissed TrueNAS alert.
Inputs: alert_id (required). Returns: result
Run a ZFS scrub on a pool.
Inputs: pool_name (required), dry_run. Returns: result
Search the TrueNAS app catalog for available apps.
Inputs: train, catalog_app. Returns: result
Start an installed app. Long-running (may take seconds).
Inputs: app_name (required). Returns: result
Stop an installed app. Long-running (may take seconds).
Inputs: app_name (required). Returns: result
Get TrueNAS system information (version, hostname, uptime, CPU, memory).
Returns: JSON string with system.info fields.
Inputs: no named parameters. Returns: result
Call any TrueNAS middleware endpoint directly.
Inputs: method (required), params. Returns: result
Update an installed app's configuration.
Inputs: values (required), app_name (required), dry_run. Returns: result
Upgrade an installed app to the latest version.
Inputs: app_name (required), dry_run. Returns: result
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
Scored across 29 tools
Most tools target clearly distinct resources and actions, especially the list/create/delete families for datasets, snapshots, and shares. Minor ambiguity exists between update_app and upgrade_app, and truenas_call overlaps with every specific tool as a generic escape hatch.
Almost all tools use consistent snake_case verb_noun naming, such as list_pools, create_dataset, and delete_share. The few deviations are system_info (noun-first) and truenas_call (noun_verb), but the overall pattern remains predictable.
TrueNAS is a broad administration domain, so many tools are justified, but 29 tools is on the heavy side and includes both granular wrappers and a generic truenas_call fallback. The set is useful but close to feeling over-expanded.
Core areas like datasets, snapshots, shares, apps, alerts, and scrubs are well covered, but VM support is list-only and there are no update operations for datasets or shares. The generic truenas_call endpoint can fill gaps, though not as cleanly as dedicated tools.
An MCP server that provides read access to your cloud storage providers, bank accounts and more.
MCP server that lets your AI assistant build and deploy apps, hosting each one at a live URL.
Nifty's MCP server — exposes tasks, projects, messages, and files as tools for AI agents.
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
