World Monitor
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.
Inspect and manage TrueNAS SCALE storage, shares, apps and system state with your own API key
Lists are ordered by a usage score (out of 100) built from these parts
| Popularity | 6/80 | GitHub stars or weekly downloads: the larger counts 60, the smaller 20 |
|---|---|---|
| Freshness | 12/12 | Full marks for a release or code change within 30 days |
| Still answering | 0/8 | The cloud endpoint answered at the last check |
| Usage score | 18/100 |
Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)
Pick the AI app you use, then copy the settings.
Let your AI install it with one sentence
Please install TrueNAS SCALE. Follow https://mcp.popnx.com/i/cedricziel-truenas-mcp.md, show me the commands and wait for my OK before running them.Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads
Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026
First: which AI do you use?
Pick your app and the steps appear below.
Works with Claude, with some setup first
1 setting(s) to fill in (TRUENAS_MCP_TARGET) · Install Docker on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server TrueNAS SCALE for Claude on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "truenas": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "TRUENAS_MCP_TARGET", "ghcr.io/cedricziel/truenas-mcp:0.4.2" ], "env": { "TRUENAS_MCP_TARGET": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For TRUENAS_MCP_TARGET, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the TrueNAS SCALE tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
TRUENAS_MCP_TARGET TrueNAS host to manage, optionally `host:port`. Requires TrueNAS SCALE 25.04 or later.Descriptions are as written by the maker.
SettingsDeveloperEdit Config
{
"mcpServers": {
"truenas": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"TRUENAS_MCP_TARGET",
"ghcr.io/cedricziel/truenas-mcp:0.4.2"
],
"env": {
"TRUENAS_MCP_TARGET": "your-value"
}
}
}
}Use TrueNAS SCALE and tell me what you can do for me, then show me one thing✓ If Claude says it is using TrueNAS SCALE or shows a TrueNAS SCALE tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
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. · default trueTRUENAS_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. · default falseTRUENAS_MCP_ENABLE_WRITES Expose the mutating tools. Read-only by default; unrecoverable operations stay unreachable either way. · default falseDescriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
ChatGPT cannot connect TrueNAS SCALE yet
TrueNAS SCALE runs on your computer, but ChatGPT can only connect servers that run on the web
A · Use an app that can connect TrueNAS SCALE
B · Others in Other that work with ChatGPT
Picked from the most used in the same category, only ones that connect by address with no key
Works with Claude Code, with some setup first
1 setting(s) to fill in (TRUENAS_MCP_TARGET) · Install Docker on your computer first (one time)
Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server TrueNAS SCALE for Claude Code on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user truenas --env TRUENAS_MCP_TARGET=your-value -- docker run -i --rm -e TRUENAS_MCP_TARGET ghcr.io/cedricziel/truenas-mcp:0.4.2 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For TRUENAS_MCP_TARGET, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the TrueNAS SCALE tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
TRUENAS_MCP_TARGET TrueNAS host to manage, optionally `host:port`. Requires TrueNAS SCALE 25.04 or later.Descriptions are as written by the maker.
Mac: press Command+Space and type Terminal · Windows: open PowerShell
claude mcp add --scope user truenas --env TRUENAS_MCP_TARGET=your-value -- docker run -i --rm -e TRUENAS_MCP_TARGET ghcr.io/cedricziel/truenas-mcp:0.4.2You should see TrueNAS SCALE listed as connected
Use TrueNAS SCALE and tell me what you can do for me, then show me one thing✓ If Claude Code says it is using TrueNAS SCALE or shows a TrueNAS SCALE tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
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. · default trueTRUENAS_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. · default falseTRUENAS_MCP_ENABLE_WRITES Expose the mutating tools. Read-only by default; unrecoverable operations stay unreachable either way. · default falseDescriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with Cursor, with some setup first
1 setting(s) to fill in (TRUENAS_MCP_TARGET) · Install Docker on your computer first (one time)
Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server TrueNAS SCALE for Cursor on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "truenas": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "TRUENAS_MCP_TARGET", "ghcr.io/cedricziel/truenas-mcp:0.4.2" ], "env": { "TRUENAS_MCP_TARGET": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For TRUENAS_MCP_TARGET, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the TrueNAS SCALE tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
TRUENAS_MCP_TARGET TrueNAS host to manage, optionally `host:port`. Requires TrueNAS SCALE 25.04 or later.Descriptions are as written by the maker.
In the TrueNAS SCALE settings, TRUENAS_MCP_TARGET is empty; add your key and save
Use TrueNAS SCALE and tell me what you can do for me, then show me one thing✓ If Cursor says it is using TrueNAS SCALE or shows a TrueNAS SCALE tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
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. · default trueTRUENAS_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. · default falseTRUENAS_MCP_ENABLE_WRITES Expose the mutating tools. Read-only by default; unrecoverable operations stay unreachable either way. · default falseDescriptions are as written by the maker.
Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with VS Code, with some setup first
1 setting(s) to fill in (TRUENAS_MCP_TARGET) · Install Docker on your computer first (one time)
Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server TrueNAS SCALE for VS Code on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "truenas": { "type": "stdio", "command": "docker", "args": [ "run", "-i", "--rm", "-e", "TRUENAS_MCP_TARGET", "ghcr.io/cedricziel/truenas-mcp:0.4.2" ], "env": { "TRUENAS_MCP_TARGET": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For TRUENAS_MCP_TARGET, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the TrueNAS SCALE tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Already installed? Check first · Open Terminal, type this command and press Enter
docker --versionMac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed
Open the Docker download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version
Install once; it works for everything that needs Docker
These are program settings, not keys. No sign-up needed; fill them in as the maker describes.
TRUENAS_MCP_TARGET TrueNAS host to manage, optionally `host:port`. Requires TrueNAS SCALE 25.04 or later.Descriptions are as written by the maker.
In the TrueNAS SCALE settings, TRUENAS_MCP_TARGET is empty; add your key and save
Use TrueNAS SCALE and tell me what you can do for me, then show me one thing✓ If VS Code says it is using TrueNAS SCALE or shows a TrueNAS SCALE tool in the answer, you are connected
The command above works without these. Add them only if you want to change something, following the maker’s description.
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. · default trueTRUENAS_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. · default falseTRUENAS_MCP_ENABLE_WRITES Expose the mutating tools. Read-only by default; unrecoverable operations stay unreachable either way. · default falseDescriptions are as written by the maker.
Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.
JSON settings are under “For developers” below
Claude Code
claude mcp add --scope user truenas --env TRUENAS_MCP_TARGET=your-value -- docker run -i --rm -e TRUENAS_MCP_TARGET ghcr.io/cedricziel/truenas-mcp:0.4.2Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"truenas": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"TRUENAS_MCP_TARGET",
"ghcr.io/cedricziel/truenas-mcp:0.4.2"
],
"env": {
"TRUENAS_MCP_TARGET": "your-value"
}
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"truenas": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"TRUENAS_MCP_TARGET",
"ghcr.io/cedricziel/truenas-mcp:0.4.2"
],
"env": {
"TRUENAS_MCP_TARGET": "your-value"
}
}
}
}VS Code (mcp.json)
{
"servers": {
"truenas": {
"type": "stdio",
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"TRUENAS_MCP_TARGET",
"ghcr.io/cedricziel/truenas-mcp:0.4.2"
],
"env": {
"TRUENAS_MCP_TARGET": "your-value"
}
}
}
}TRUENAS_MCP_TARGET required envTRUENAS_MCP_ALLOW_PLAINTEXT envTRUENAS_MCP_TARGET_INSECURE envTRUENAS_MCP_ENABLE_WRITES envDescriptions are as written by the maker.
These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.
Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.
Run on your computer in
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
Runs on your computer; the tool list appears in your AI app after you install it.
We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 19, 2026
The registry name was verified with the GitHub account cedricziel, which owns the repo
Code last changed 3 days ago
Uses MIT
This one runs on your computer; there is no internet endpoint
Runs on your computer and uses local settings instead
Runs on your computer; we can only read tool lists from internet endpoints
Not checked: only npm and PyPI packages with a version can be checked
If you made this, paste this code into your README. The badge links back to this page.
[](https://mcp.popnx.com/en/servers/cedricziel-truenas-mcp)Ask, share a tip or report that it does not work. Sorted by what people marked helpful.
No posts yet. Be the first to ask or share.
Posts here are written by users, not the PopNx team.
No reviews yet
Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.
It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.
The registry does not list a required key, though some servers ask you to sign in on first use.
It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).
The GitHub repo last changed 3 days ago, and the latest version (0.4.2) reached the registry 3 months ago.
Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Docker on your computer.
In the same category: World Monitor, openstatus, Oh My Posh Validator, Strata, Jitsu
Same category, other makers, commands already checked. Official ones first, then by stars.
Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi
Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.
Manage monitors, status pages, incidents and maintenances in your openstatus workspace.
Validate oh-my-posh configurations and segment snippets against the official schema.
MCP server for progressive tool usage at any scale (see https://klavis.ai)
Manage Jitsu data pipelines: destinations, streams, connections, functions, live events.
| This one TrueNAS SCALE | World Monitor | openstatus | Oh My Posh Validator | Strata | Jitsu | |
|---|---|---|---|---|---|---|
| Runs where | Installs on your computer | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install |
| Needs a key | No | No | No | No | No | No |
| Add with + in Claude | No | No | No | No | No | No |
| Basic checks | 3/3 | 4/4 | 4/4 | 4/4 | 1/4 | 4/4 |
| License | MIT | AGPL-3.0 | AGPL-3.0 | MIT | Apache-2.0 | MIT |
| Price | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry |
Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.
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.
iX ship an official truenas/truenas-mcp, and if it fits your needs you should use it. This one exists for three things it does not do:
Three ideas do most of the work.
The credential is the authorization. Callers supply their own TrueNAS API key; this server stores none. A session reaches exactly what that user's key permits, revocation happens in the TrueNAS UI, and there is no shared secret to leak. Authentication and authorization stop being two systems that can disagree. Served over stdio the key arrives from the environment instead, because there is no request to carry it — but the client spawns one process per user, so it is still that user's own key. What the design rules out is one key standing in for many callers, not configuration as such.
Reads and writes get different tool shapes. Reads are grouped into concern-level tools with an op enum, because they share most of their arguments and 815 middleware methods cannot each become a tool. Writes are individual tools — MCP annotations are per-tool, so bundling a safe operation with a destructive one behind one op parameter would put both behind a single consent gate, and a user who tires of confirming list_pools will allowlist the tool that can also export a pool.
Read-only by default. Mutating tools appear only when explicitly enabled. Separately, a denylist of unrecoverable operations is not reachable under any configuration, and it constrains argument values rather than just method names — deleting an app is recoverable, deleting it along with its volumes is not, and those are the same method.
Each of these was measured against a live box rather than reasoned about in the abstract, and several were overturned by what that measurement found.
Copy deploy/truenas-custom-app.yaml, adjust TRUENAS_MCP_TARGET, and paste it into Apps → Discover → Install via YAML.
It mounts no host socket and requests no privileged access. The server reaches the middleware over the network even when running on the same box, so that every connection carries a user identity rather than root-equivalent socket access.
Nothing requires the server to run on the machine it manages, and there is a good reason not to: installed as a TrueNAS app, it is unavailable exactly when the box is unhealthy — which is when you most want to ask it what is wrong.
docker run -p 8080:8080 \
-e TRUENAS_MCP_TARGET=nas.local \ -e TRUENAS_MCP_TLS_CERT=/tls/cert.pem \ -e TRUENAS_MCP_TLS_KEY=/tls/key.pem \ ghcr.io/cedricziel/truenas-mcp:main
Each GitHub release attaches binaries for Linux, macOS, and Windows on amd64 and arm64, alongside a checksums.txt. Configuration is environment variables only — there is no config file, and the only flags are --stdio and --healthcheck.
By default the binary is an HTTP server. Running it does not make a client pick it up on its own; it listens on a port, and the client connects to it by URL. For clients that spawn the server themselves, see Serving over stdio below.
TRUENAS_MCP_TARGET=nas.local \
TRUENAS_MCP_LISTEN=127.0.0.1:8080 \ TRUENAS_MCP_TARGET_INSECURE=true \ TRUENAS_MCP_ALLOW_PLAINTEXT=true \ ./truenas-mcp
Point the client at http://localhost:8080/mcp, with the TrueNAS API key sent as an Authorization: Bearer header, the same as in Connecting a client.
TRUENAS_MCP_TARGET_INSECURE is typically needed for the reason given in On the two TLS settings: TrueNAS ships a self-signed certificate for CN=localhost that will not validate against any other address. TRUENAS_MCP_ALLOW_PLAINTEXT is defensible here specifically because TRUENAS_MCP_LISTEN binds the listener to loopback — reachable only from the same machine — which is the condition that section argues plaintext requires. The default bind address is :8080, which is every interface, so dropping that setting while keeping plaintext would put API keys on the wire.
Some clients spawn a server as a subprocess and talk to it over its standard input and output rather than connecting to a URL. --stdio serves the same tools that way.
claude mcp add --scope user truenas \
--env TRUENAS_MCP_TARGET=nas.local \ --env TRUENAS_MCP_TARGET_INSECURE=true \ --env TRUENAS_MCP_API_KEY=$YOUR_TRUENAS_API_KEY \ -- /path/to/truenas-mcp --stdio
There is no request to carry a header here, so the key comes from TRUENAS_MCP_API_KEY instead. That is not the shared secret the HTTP transport avoids: the client spawns one process per user, so the key it passes is that user's own, and the process reaches exactly what that key permits. The same variable is refused in HTTP mode, where one process serves many callers and a configured key would be shared by all of them.
Nothing about the listener applies. TRUENAS_MCP_LISTEN, the two TLS settings and TRUENAS_MCP_ALLOW_PLAINTEXT are ignored with a warning rather than an error, since none of them weakens anything when no listener exists. --healthcheck is refused alongside --stdio, because it probes a listener that was never started.
Settings that concern the target rather than the listener still apply, including TRUENAS_MCP_TARGET_INSECURE and TRUENAS_MCP_ENABLE_WRITES.
All configuration is environment variables; no config file or persistent volume is needed. Invalid configuration refuses to start rather than running degraded.
| Variable | Default | Meaning |
|---|---|---|
TRUENAS_MCP_TARGET | _required_ | TrueNAS host, optionally host:port |
TRUENAS_MCP_LISTEN | :8080 | Bind address |
TRUENAS_MCP_TLS_CERT / TRUENAS_MCP_TLS_KEY | — | Serve MCP over TLS |
TRUENAS_MCP_ALLOW_PLAINTEXT | false | Serve without TLS (see below) |
TRUENAS_MCP_TARGET_INSECURE | false | Accept the target's certificate unverified |
TRUENAS_MCP_TARGET_ALLOW_PLAINTEXT | false | Connect to the target without TLS |
TRUENAS_MCP_ENABLE_WRITES | false | Expose mutating tools |
TRUENAS_MCP_API_KEY | — | Credential for --stdio; refused otherwise |
TRUENAS_MCP_OAUTH_ISSUER | — | Enables OAuth; the server's own externally-reachable base URL |
TRUENAS_MCP_OAUTH_ENCRYPTION_KEY | _generated_ | 64 hex characters (32 bytes); see below |
TRUENAS_MCP_OAUTH_ACCESS_TOKEN_TTL | 1h | How long an issued OAuth access token is valid |
TRUENAS_MCP_OAUTH_REFRESH_TOKEN_TTL | 720h (30 days) | How long a refresh token is valid; 0 disables refresh tokens |
No credential is configurable for the HTTP transport. Callers supply their own with each request, and setting TRUENAS_MCP_API_KEY without --stdio is a startup error rather than a silent fallback. Over stdio there is no request to carry one and the process serves a single user, so the variable is how that user's key arrives — see Serving over stdio.
Transport scheme and certificate verification are deliberately separate.
TrueNAS ships a self-signed certificate issued for CN=localhost with only DNS:localhost as a SAN, so no address you can reach it by will validate. The fix is TRUENAS_MCP_TARGET_INSECURE=true, which keeps the connection encrypted and merely unauthenticated. If certificate problems forced you onto plaintext instead, TrueNAS would see your API key in the clear — and revoke it.
TRUENAS_MCP_ALLOW_PLAINTEXT is about the boundary callers cross, which carries their API keys. It is correct when a reverse proxy terminates TLS in front of the server, and wrong when the plaintext listener is reachable directly.
claude mcp add --scope user --transport http truenas \
https://your-host/mcp \ --header "Authorization: Bearer $YOUR_TRUENAS_API_KEY"
The key may also be sent as X-TrueNAS-API-Key, for clients that cannot set an Authorization header. Requests without either are refused with 401.
Clients that spawn the server rather than connect to one want Serving over stdio instead.
A hosted MCP client such as Claude.ai never holds a TrueNAS API key directly — it only speaks OAuth 2.1: discovery, Dynamic Client Registration (RFC 7591), and an authorization-code flow with PKCE. Set an issuer URL to turn that on:
docker run -p 8080:8080 \
-e TRUENAS_MCP_TARGET=nas.local \ -e TRUENAS_MCP_TLS_CERT=/tls/cert.pem \ -e TRUENAS_MCP_TLS_KEY=/tls/key.pem \ -e TRUENAS_MCP_OAUTH_ISSUER=https://your-host \ -e TRUENAS_MCP_OAUTH_ENCRYPTION_KEY=$(openssl rand -hex 32) \ ghcr.io/cedricziel/truenas-mcp:main
TRUENAS_MCP_OAUTH_ISSUER must be the exact base URL the server is reachable at from the client's side (no trailing slash). TRUENAS_MCP_OAUTH_ENCRYPTION_KEY seals every client registration, authorization code, and token this process issues; leaving it unset works, but a fresh key is generated on every restart and invalidates every outstanding one — set it explicitly for anything longer than a quick trial. Neither TrueNAS credentials nor a client/token database are stored anywhere: everything OAuth issues is self-contained, verified with this one key. See openspec/changes/oauth-dcr-authorization/design.md for why.
Point a client at https://your-host/mcp the same way you would for the raw API key above; it discovers everything else — the authorization server, where to register, where to send the resource owner — from /.well-known/oauth-protected-resource. The first connection opens a browser consent screen asking for a TrueNAS username (optional, shown only to you) and API key; nothing is granted to the client until that's submitted and the target accepts it.
TRUENAS_MCP_ALLOW_PLAINTEXT works the same way it does for the raw-API-key path: it is meant for a reverse proxy that terminates TLS at the edge and forwards plaintext to this process, not for exposing the consent screen over the open internet unencrypt