truenas-mcp
truenas-mcp¶
An MCP server that exposes TrueNAS SCALE management capabilities to AI assistants. It connects to a TrueNAS SCALE appliance through the WebSocket JSON-RPC API and gives an AI client tools for storage, sharing, system and app management over stdio. It starts read-only: tools that change the appliance exist only when you enable them.
Install truenas-mcp covers the requirements, the release packages and the build from source.
What truenas-mcp gives you¶
-
One view of the appliance
Tools list pools, datasets, snapshots, shares, alerts, apps and jobs. Reports such as
truenas_health_reportandtruenas_protection_reportcombine several queries into 1 answer. -
Read-only by default
A plain
truenas-mcp serveregisters only the 24 read-only tools. The 20 write tools exist only with--enable-writes. See read-only by default. -
Plain configuration
2 required settings, the appliance host and an API key, as flags or environment variables. See configuration.
-
No replay of writes
The server checks the connection before each call and reconnects when the check fails. It never sends a call again after a transport error, because a write may already have taken effect.