TrueNAS SCALE

MCP server · by cedricziel

Developer Tools Docker v0.4.2

Inspect and manage TrueNAS SCALE storage, shares, apps and system state with your own API key

View source ↗ Website ↗ Generate config for multiple servers More servers

Install

Pin version unavailable — the image reference already carries a tag

Docker
docker run -i --rm ghcr.io/cedricziel/truenas-mcp:0.4.2

Setup by client

Pick your client — the config below is generated for this server (local stdio). Copy respects the “Pin version” switch above.

claude_desktop_config.json

{
  "mcpServers": {
    "truenas-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/cedricziel/truenas-mcp:0.4.2"
      ],
      "env": {
        "TRUENAS_MCP_TARGET": "<YOUR_TRUENAS_MCP_TARGET>"
      }
    }
  }
}

Format verified against the official Claude Desktop docs ↗.

terminal

claude mcp add --env TRUENAS_MCP_TARGET=<YOUR_TRUENAS_MCP_TARGET> truenas-mcp -- docker run -i --rm ghcr.io/cedricziel/truenas-mcp:0.4.2

Format verified against the official Claude Code docs ↗.

.cursor/mcp.json

{
  "mcpServers": {
    "truenas-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/cedricziel/truenas-mcp:0.4.2"
      ],
      "env": {
        "TRUENAS_MCP_TARGET": "<YOUR_TRUENAS_MCP_TARGET>"
      }
    }
  }
}

Format verified against the official Cursor docs ↗.

.vscode/mcp.json

{
  "servers": {
    "truenas-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/cedricziel/truenas-mcp:0.4.2"
      ],
      "env": {
        "TRUENAS_MCP_TARGET": "<YOUR_TRUENAS_MCP_TARGET>"
      }
    }
  }
}

Format verified against the official VS Code docs ↗.

mcp_config.json

{
  "mcpServers": {
    "truenas-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/cedricziel/truenas-mcp:0.4.2"
      ],
      "env": {
        "TRUENAS_MCP_TARGET": "<YOUR_TRUENAS_MCP_TARGET>"
      }
    }
  }
}

Format verified against the official Windsurf docs ↗.

Environment variables

Defined in the server's official registry manifest. Required secrets are shown as <YOUR_…> placeholders in the configs above.

TRUENAS_MCP_TARGET required — TrueNAS host to manage, optionally `host:port`. Requires TrueNAS SCALE 25.04 or later.
TRUENAS_MCP_ALLOW_PLAINTEXT — Serve MCP without TLS. Set here because the listener is published on loopback only; drop it and supply TRUENAS_MCP_TLS_CERT/KEY if the port is reachable from elsewhere.
TRUENAS_MCP_TARGET_INSECURE — Accept the TrueNAS certificate unverified while keeping the connection encrypted. TrueNAS ships a self-signed certificate for `CN=localhost`, so no address you can reach it by will validate.
TRUENAS_MCP_ENABLE_WRITES — Expose the mutating tools. Read-only by default; unrecoverable operations stay unreachable either way.

GitHub

⭐ 1 stars · 最近更新于 17 天前 · MIT license

About this server

truenas mcp An MCP server for TrueNAS SCALE. Read first, deployable as a TrueNAS app, and authenticated with each user's own API key. Status: working, young. Every capability in the design is implemented and verified against a live TrueNAS 26 box. Expect rough edges rather than gaps. Why this exists…

Summary from the project README — github.com/cedricziel/truenas-mcp

Distributed as Docker, listed under Developer Tools. Review our MCP security guide before granting access to real data.

Frequently asked questions

What does the TrueNAS SCALE MCP server do?

How do I install TrueNAS SCALE?

Run the install command shown above, then paste the config for your client (Claude Desktop, Claude Code, Cursor, VS Code or Windsurf) into its MCP settings and restart the client.

Is TrueNAS SCALE free to use?

The MCP server itself is free to install. The source is public on https://github.com/cedricziel/truenas-mcp. Any third-party service it calls may require its own API key and account.

Which clients support TrueNAS SCALE?

Any MCP-compatible client can use it, including Claude Desktop, Claude Code, Cursor, VS Code, Windsurf and custom agents.

Add this badge

Publish this server? Link back with a badge on your README or site — copy either snippet.

Markdown

[![Listed on MCPNav](https://mcpnav.net/badge/truenas-mcp.svg)](https://mcpnav.net/server/truenas-mcp/)

HTML

<a href="https://mcpnav.net/server/truenas-mcp/"><img src="https://mcpnav.net/badge/truenas-mcp.svg" alt="Listed on MCPNav" height="20"></a>