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
列表按使用分(满分 100)排序,由以下部分组成
| 热度 | 6/80 | GitHub 星标或每周下载量:较大的计 60,较小的计 20 |
|---|---|---|
| 新鲜度 | 12/12 | 30 天内有发布或代码更新得满分 |
| 仍在响应 | 0/8 | 上次检查时云端端点有响应 |
| 使用分 | 18/100 |
质量: 基础检查通过 3/3 项(仅展示,不用于排序) · 上升势头: 暂无数据 (只用于“上升中”标签)
选择你使用的 AI 应用,然后复制设置。
用一句话让 AI 帮你安装
请帮我安装 TrueNAS SCALE。按照 https://mcp.popnx.com/i/cedricziel-truenas-mcp.md 操作,先把命令给我看,等我同意后再运行。粘贴到能在你电脑上工作的 AI(如 Claude Code、Cursor)。它会读取我们的步骤,先给你看命令,等你同意。无需密钥,无需注册。 · 查看 AI 会读取的全文
通过 3/3 项检查 · 在你的电脑上运行 · ✓ 命令已检查 2026年11月14日
第一步:你用哪个 AI?
选择你用的应用,步骤会显示在下方。
可连接 Claude,但需要先准备
需要填写 1 项设置(TRUENAS_MCP_TARGET) · 需要先在电脑上安装 Docker(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
把这段话复制到 Claude 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude 安装 MCP server TrueNAS SCALE,按顺序:1) 用 docker --version 检查是否有 Docker。没有的话,请让我从 https://www.docker.com/products/docker-desktop/ 安装,不要自己安装。2) 只使用这份配置(已通过 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) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) TRUENAS_MCP_TARGET 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 TrueNAS SCALE 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
docker --versionMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 安装 Docker Desktop:Mac 打开 Docker.dmg,把图标拖到“应用程序”(按电脑选择 Apple silicon 或 Intel 版本)· Windows 双击 Docker Desktop Installer.exe · 装好后打开 Docker Desktop 应用并保持运行。不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: docker --version
安装一次,所有需要 Docker 的工具都能用
这些是程序设置,不是密钥,无需注册。按开发者的说明填写。
TRUENAS_MCP_TARGET 要管理的 TrueNAS 主机,可选填 host:port。需要 TrueNAS SCALE 25.04 或更高版本。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
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"
}
}
}
}用 TrueNAS SCALE 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude 说正在使用 TrueNAS SCALE,或回答中出现 TrueNAS SCALE 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
TRUENAS_MCP_ALLOW_PLAINTEXT 在没有 TLS 的情况下提供 MCP。此处设置是因为监听器仅发布在 loopback 上;如果该端口可从其他位置访问,请删除此设置并提供 TRUENAS_MCP_TLS_CERT/KEY。 TRUENAS_MCP_TARGET_INSECURE 接受未经验证的 TrueNAS 证书,同时保持连接加密。TrueNAS 附带一个针对 CN=localhost 的自签名证书,因此你能用来访问它的任何地址都无法通过验证。 TRUENAS_MCP_ENABLE_WRITES 公开可修改数据的工具。默认仅允许只读;无法恢复的操作在任何情况下都无法访问。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
ChatGPT 暂时无法连接 TrueNAS SCALE
TrueNAS SCALE 需要安装在你的电脑上,而 ChatGPT 只能连接在网上运行的服务器
A · 使用能连接 TrueNAS SCALE 的应用
B · 其他 类中能连接 ChatGPT 的其他服务器
从同类中使用较多的里挑选,仅限用地址即可连接、无需密钥的
可连接 Claude Code,但需要先准备
需要填写 1 项设置(TRUENAS_MCP_TARGET) · 需要先在电脑上安装 Docker(只需一次)
把这段话复制到 Claude Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude Code 安装 MCP server TrueNAS SCALE,按顺序:1) 用 docker --version 检查是否有 Docker。没有的话,请让我从 https://www.docker.com/products/docker-desktop/ 安装,不要自己安装。2) 只使用这份配置(已通过 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) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) TRUENAS_MCP_TARGET 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 TrueNAS SCALE 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
docker --versionMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 安装 Docker Desktop:Mac 打开 Docker.dmg,把图标拖到“应用程序”(按电脑选择 Apple silicon 或 Intel 版本)· Windows 双击 Docker Desktop Installer.exe · 装好后打开 Docker Desktop 应用并保持运行。不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: docker --version
安装一次,所有需要 Docker 的工具都能用
这些是程序设置,不是密钥,无需注册。按开发者的说明填写。
TRUENAS_MCP_TARGET 要管理的 TrueNAS 主机,可选填 host:port。需要 TrueNAS SCALE 25.04 或更高版本。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
Mac:按 Command+空格,输入 Terminal · Windows:打开 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.2应能看到 TrueNAS SCALE 在列表中并显示已连接
用 TrueNAS SCALE 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude Code 说正在使用 TrueNAS SCALE,或回答中出现 TrueNAS SCALE 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
TRUENAS_MCP_ALLOW_PLAINTEXT 在没有 TLS 的情况下提供 MCP。此处设置是因为监听器仅发布在 loopback 上;如果该端口可从其他位置访问,请删除此设置并提供 TRUENAS_MCP_TLS_CERT/KEY。 TRUENAS_MCP_TARGET_INSECURE 接受未经验证的 TrueNAS 证书,同时保持连接加密。TrueNAS 附带一个针对 CN=localhost 的自签名证书,因此你能用来访问它的任何地址都无法通过验证。 TRUENAS_MCP_ENABLE_WRITES 公开可修改数据的工具。默认仅允许只读;无法恢复的操作在任何情况下都无法访问。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
可连接 Cursor,但需要先准备
需要填写 1 项设置(TRUENAS_MCP_TARGET) · 需要先在电脑上安装 Docker(只需一次)
把这段话复制到 Cursor 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Cursor 安装 MCP server TrueNAS SCALE,按顺序:1) 用 docker --version 检查是否有 Docker。没有的话,请让我从 https://www.docker.com/products/docker-desktop/ 安装,不要自己安装。2) 只使用这份配置(已通过 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) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) TRUENAS_MCP_TARGET 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 TrueNAS SCALE 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
docker --versionMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 安装 Docker Desktop:Mac 打开 Docker.dmg,把图标拖到“应用程序”(按电脑选择 Apple silicon 或 Intel 版本)· Windows 双击 Docker Desktop Installer.exe · 装好后打开 Docker Desktop 应用并保持运行。不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: docker --version
安装一次,所有需要 Docker 的工具都能用
这些是程序设置,不是密钥,无需注册。按开发者的说明填写。
TRUENAS_MCP_TARGET 要管理的 TrueNAS 主机,可选填 host:port。需要 TrueNAS SCALE 25.04 或更高版本。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
在 TrueNAS SCALE 的设置中,TRUENAS_MCP_TARGET 还是空的,填入你的密钥并保存
用 TrueNAS SCALE 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Cursor 说正在使用 TrueNAS SCALE,或回答中出现 TrueNAS SCALE 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
TRUENAS_MCP_ALLOW_PLAINTEXT 在没有 TLS 的情况下提供 MCP。此处设置是因为监听器仅发布在 loopback 上;如果该端口可从其他位置访问,请删除此设置并提供 TRUENAS_MCP_TLS_CERT/KEY。 TRUENAS_MCP_TARGET_INSECURE 接受未经验证的 TrueNAS 证书,同时保持连接加密。TrueNAS 附带一个针对 CN=localhost 的自签名证书,因此你能用来访问它的任何地址都无法通过验证。 TRUENAS_MCP_ENABLE_WRITES 公开可修改数据的工具。默认仅允许只读;无法恢复的操作在任何情况下都无法访问。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Cursor 帮助页面核实 · 你的界面可能因版本略有不同
可连接 VS Code,但需要先准备
需要填写 1 项设置(TRUENAS_MCP_TARGET) · 需要先在电脑上安装 Docker(只需一次)
把这段话复制到 VS Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 VS Code 安装 MCP server TrueNAS SCALE,按顺序:1) 用 docker --version 检查是否有 Docker。没有的话,请让我从 https://www.docker.com/products/docker-desktop/ 安装,不要自己安装。2) 只使用这份配置(已通过 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) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) TRUENAS_MCP_TARGET 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 TrueNAS SCALE 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
docker --versionMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 安装 Docker Desktop:Mac 打开 Docker.dmg,把图标拖到“应用程序”(按电脑选择 Apple silicon 或 Intel 版本)· Windows 双击 Docker Desktop Installer.exe · 装好后打开 Docker Desktop 应用并保持运行。不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: docker --version
安装一次,所有需要 Docker 的工具都能用
这些是程序设置,不是密钥,无需注册。按开发者的说明填写。
TRUENAS_MCP_TARGET 要管理的 TrueNAS 主机,可选填 host:port。需要 TrueNAS SCALE 25.04 或更高版本。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
在 TrueNAS SCALE 的设置中,TRUENAS_MCP_TARGET 还是空的,填入你的密钥并保存
用 TrueNAS SCALE 告诉我你能帮我做什么,然后做一件给我看✓ 如果 VS Code 说正在使用 TrueNAS SCALE,或回答中出现 TrueNAS SCALE 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
TRUENAS_MCP_ALLOW_PLAINTEXT 在没有 TLS 的情况下提供 MCP。此处设置是因为监听器仅发布在 loopback 上;如果该端口可从其他位置访问,请删除此设置并提供 TRUENAS_MCP_TLS_CERT/KEY。 TRUENAS_MCP_TARGET_INSECURE 接受未经验证的 TrueNAS 证书,同时保持连接加密。TrueNAS 附带一个针对 CN=localhost 的自签名证书,因此你能用来访问它的任何地址都无法通过验证。 TRUENAS_MCP_ENABLE_WRITES 公开可修改数据的工具。默认仅允许只读;无法恢复的操作在任何情况下都无法访问。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 VS Code 帮助页面核实 · 你的界面可能因版本略有不同
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 必填 envTRUENAS_MCP_ALLOW_PLAINTEXT envTRUENAS_MCP_TARGET_INSECURE envTRUENAS_MCP_ENABLE_WRITES env说明为自动翻译,变量名保持原样;不确定时请查看原文。
这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
依据这个服务器的连接方式和各应用自己的文档,检查于 2026年11月10日。
在你的电脑上运行,适用于
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
它在你的电脑上运行;安装后,工具列表会显示在你的 AI 应用中。
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月19日
注册名称已通过 GitHub 账户 cedricziel 验证,该账户拥有此仓库
代码最后更新于3天前
使用 MIT
它在你的电脑上运行,没有互联网端点
在你的电脑上运行,改用本地设置
它在你的电脑上运行;我们只能读取互联网端点的工具列表
如果你是作者,可把这段代码贴到 README。徽章会链接回本页。
[](https://mcp.popnx.com/en/servers/cedricziel-truenas-mcp)提问、分享技巧或报告无法使用。按“有帮助”数量排序。
还没有评价
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
它在 3 项适用的基础检查中通过了 3 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
注册中心没有列出必需的密钥,不过有些服务器会在首次使用时要求你登录。
它在你的电脑上运行。你的 AI 应用会在需要时启动它,数据不会经过作者的服务器(除非它自己调用在线服务)。
GitHub 仓库最后更新于3天前,最新版本(0.4.2)于3个月前进入注册中心。
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Docker。
同一分类中有:World Monitor, openstatus, Oh My Posh Validator, Strata, Jitsu
同一分类、其他作者、命令已通过检查。官方的排在前面,再按星标排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
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.
| 本项 TrueNAS SCALE | World Monitor | openstatus | Oh My Posh Validator | Strata | Jitsu | |
|---|---|---|---|---|---|---|
| 运行位置 | 需要安装在电脑上 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 |
| 需要密钥 | 否 | 否 | 否 | 否 | 否 | 否 |
| 可在 Claude 中按 + 添加 | 否 | 否 | 否 | 否 | 否 | 否 |
| 基础检查 | 3/3 | 4/4 | 4/4 | 4/4 | 1/4 | 4/4 |
| 许可证 | MIT | AGPL-3.0 | AGPL-3.0 | MIT | Apache-2.0 | MIT |
| 价格 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 |
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
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