Truenas MCP Fbb18a15

MCP运维云端

提供方 gordcurrie

运维云端 未标注 无需鉴权 社区 / 第三方 Claude DesktopClaude

一个将TrueNAS SCALE操作作为MCP工具暴露的服务器,支持系统管理、网络、文件系统、存储、虚拟机和应用管理。

一句话选型结论

按资料字段整理

Truenas MCP Fbb18a15 属于运维云端类 MCP 服务器,传输方式未标注,无需鉴权,可直接接入 Claude Desktop、Claude,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类运维云端 传输方式未标注 鉴权无需鉴权 部署方式未标注
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 36 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

运维云端
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量36暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

系统管理Go本地部署网络管理文件系统存储管理虚拟机管理应用管理

安装与配置

未标注 无需鉴权
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 36 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
云资源查询

查实例、存储、账单等云上资源状态。

部署与发布

把部署、重启、回滚这类操作接进对话。

监控与告警

拉取监控指标,异常时让模型帮你判断。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 36 个工具,覆盖面较广,能满足多种调用。
  • 已适配 Claude Desktop、Claude,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在运维云端场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Truenas MCP Fbb18a15当前 36 未标注 未标注 无 2026-05-17
lobehub 未标注 stdio · 本地进程 本地部署 有 2026-04-11
TrendRadar 未标注 stdio · 本地进程 本地部署 有 2026-04-13
Ui Tars Desktop 8a825770 未标注 stdio · 本地进程 本地部署 有 2026-05-17
ruflo 未标注 stdio · 本地进程 本地部署 有 2026-04-13
FastGPT 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

运维云端
字段来自项目仓库与公开索引,中文说明由本站标注
提供方gordcurrie上游标注的维护方 gordcurrie
分类运维云端本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

11.8 KB
来自项目仓库与上游目录的原文,未做删改

truenas-mcp

An MCP server that exposes TrueNAS SCALE operations as MCP tools, written in Go.

Tools

System

Tool Description Parameters
get_system_info Get TrueNAS SCALE system info: version, hostname, CPU, memory, uptime, load (none)

Network

Tool Description Parameters
list_interfaces List all network interfaces (bridges, physical, bonds, VLANs) — useful for finding bridge names when attaching VM NICs (none)

Filesystem

Tool Description Parameters
list_directory List the contents of a directory on the TrueNAS host filesystem path (string, required)

Storage

Tool Description Parameters
list_pools List all ZFS storage pools and their status, size, and health limit, offset (int, optional — server-side pagination)
get_pool Get detailed information about a specific ZFS pool id (int)
list_datasets List ZFS datasets and zvols, optionally filtered by pool pool (string, optional); limit, offset (int, optional — server-side pagination)
get_dataset Get detailed information about a specific ZFS dataset or zvol by its full path id (string, e.g. Storage/backups)
create_dataset Create a new ZFS dataset or zvol name (string, required); type, compression, comments, quota, volsize (optional — volsize in bytes is required when type=VOLUME)

Virtual Machines

Tool Description Parameters
list_vms List all VMs and their state (RUNNING/STOPPED), CPU, and memory limit, offset (int, optional — server-side pagination)
get_vm Get detailed information about a specific VM id (int)
start_vm Start a VM; waits for the job and returns its result id (int)
stop_vm Stop a VM; set force=true to forcibly terminate; waits for the job and returns its result id (int); force (bool, optional)
restart_vm Restart a VM; waits for the job and returns its result id (int)
create_vm Create a new VM; returns the created VM name, memory (required); vcpus, bootloader, autostart, cores, threads, cpu_mode, cpu_model, shutdown_timeout, description (optional)
update_vm Update an existing VM configuration; omitted fields are unchanged id (required); any subset of name, memory, vcpus, bootloader, cores, threads, cpu_mode, cpu_model, shutdown_timeout, description
list_vm_devices List all hardware devices attached to a VM (disks, CDROMs, NICs, displays) id (int)
add_vm_device Attach a hardware device to a VM (DISK, CDROM, NIC, or DISPLAY) vm_id (int), dtype (string), attributes (object); order (optional)

Apps

Tool Description Parameters
list_apps List all apps managed by TrueNAS SCALE limit, offset (int, optional — server-side pagination)
get_app Get detailed information about a specific app by its app name name (string)
start_app Start an app; waits for the job and returns its result name (string)
stop_app Stop a running app; waits for the job and returns its result name (string)
restart_app Restart an app; waits for the job and returns its result name (string)
list_images List all Docker images stored on the TrueNAS SCALE system (none)
install_app Install a catalog app from the TrueNAS app catalog; waits for the job and returns its result app_name (string); catalog_app (string); train (string, default: stable); version (string, default: latest)
install_custom_app Install a custom Docker Compose app; waits for the job and returns its result app_name (string); custom_compose_config_string (string, YAML)
upgrade_app Upgrade an app to a newer version; waits for the job and returns its result name (string); version (string, optional — omit for latest)
upgrade_summary Get upgrade availability and changelog for an app name (string)
rollback_app Roll an app back to a previous version; waits for the job and returns its result name (string); version (string, required)

Job tools (start_vm, stop_vm, restart_vm and the app lifecycle, install, upgrade and rollback tools) wait up to 10 minutes for the TrueNAS job to finish and return {"result": ...}. Older TrueNAS releases return the job ID as the result instead. If the wait times out, the job keeps running on TrueNAS; check get_vm or get_app before retrying.

ZFS Snapshots

Tool Description Parameters
list_snapshots List ZFS snapshots, optionally filtered by dataset path dataset (string, optional); limit, offset (int, optional — server-side pagination)
get_snapshot Get detailed information about a specific snapshot id (string, e.g. Storage/backups@before-upgrade)
create_snapshot Create a new ZFS snapshot of a dataset dataset, name (required); recursive (bool, optional)

Destructive (requires TRUENAS_ALLOW_DESTRUCTIVE=true)

Tool Description Parameters
delete_vm Permanently delete a stopped VM id (int); confirmed: true (required)
delete_app Permanently delete a TrueNAS app name (string); confirmed: true (required)
delete_snapshot Permanently delete a ZFS snapshot id (string, e.g. Storage/backups@before-upgrade); confirmed: true (required)
delete_vm_device Remove a hardware device from a VM by device ID id (int); confirmed: true (required)
rollback_snapshot Roll a dataset back to a previous snapshot — all data written after the snapshot is permanently destroyed id (string); confirmed: true (required); recursive, recursive_clones, force (optional)

Tool annotations

Every tool advertises MCP tool annotations so clients can decide when to ask for confirmation:

Annotation Tools
readOnlyHint: true All get_* and list_* tools, plus upgrade_summary
destructiveHint: false Additive tools: create_dataset, create_snapshot, create_vm, add_vm_device, install_app, install_custom_app, start_vm, start_app
destructiveHint: true Tools that overwrite or interrupt existing state: update_vm, stop_vm, restart_vm, stop_app, restart_app, upgrade_app, rollback_app, and every tool in the Destructive table

Installation

Download a pre-built binary

Download the latest release for your platform from the Releases page.

Platform Binary
Linux (amd64) truenas-mcp_linux_amd64
Linux (arm64) truenas-mcp_linux_arm64
macOS (amd64) truenas-mcp_darwin_amd64
macOS (arm64) truenas-mcp_darwin_arm64
Windows (amd64) truenas-mcp_windows_amd64.exe

Each release also includes checksums.txt with SHA-256 hashes of every binary. Download it into the same directory and verify before running:```bash

Linux

sha256sum --check --ignore-missing checksums.txt

macOS

shasum -a 256 --check --ignore-missing checksums.txt


Windows users can compare the output of `Get-FileHash truenas-mcp_windows_amd64.exe` (PowerShell) against the matching line.

Make it executable and place it on your `PATH` (substitute the filename for your platform):```bash
chmod +x <binary-name>
mv <binary-name> /usr/local/bin/truenas-mcp

> Windows users: rename the .exe and add it to a directory on your %PATH%.

> macOS users: if Gatekeeper blocks the downloaded binary, clear the quarantine flag with xattr -d com.apple.quarantine /usr/local/bin/truenas-mcp.

Confirm the installed version:```bash
truenas-mcp --version


### Install with Go

Requires Go 1.27.3+. Installs `truenas-mcp` into `$(go env GOPATH)/bin`:```bash
go install github.com/gordcurrie/truenas-mcp/cmd/truenas-mcp@latest

Build from source

Requires Go 1.27.3+. You will also need a TrueNAS SCALE instance and an API key — create one in the TrueNAS UI under Credentials → API Keys.```bash
git clone https://github.com/gordcurrie/truenas-mcp
cd truenas-mcp
cp .env.example .env # copy the example env file
$EDITOR .env # set TRUENAS_* values (see table below)
make build # binary lands in bin/truenas-mcp


## Configuration

All configuration is via environment variables:

| Variable | Required | Description |
|---|---|---|
| `TRUENAS_API_URL` | yes | e.g. `https://truenas.local` |
| `TRUENAS_API_KEY` | yes | API key from TrueNAS UI |
| `TRUENAS_INSECURE` | no | `true` to skip TLS verification (self-signed certs) |
| `TRUENAS_ALLOW_DESTRUCTIVE` | no | `true` to enable destructive tools (default: disabled) |

## MCP Client Setup

### Running```bash
# stdio (default — for use with local MCP clients)
TRUENAS_API_URL=https://truenas.local \
TRUENAS_API_KEY=your-api-key \
./truenas-mcp

# HTTP transport (for remote or shared deployments)
./truenas-mcp --transport http --addr localhost:8081

Claude Code```bash

claude mcp add truenas --scope user \
-e TRUENAS_API_URL=https://truenas.local \
-e TRUENAS_API_KEY=your-api-key \
-- /path/to/truenas-mcp


Run `/mcp` inside Claude Code to confirm the server is connected.

### VS Code Copilot

Create `.vscode/mcp.json` in your workspace (already gitignored):```json
{
  "servers": {
    "truenas": {
      "type": "stdio",
      "command": "/path/to/truenas-mcp",
      "env": {
        "TRUENAS_API_URL": "https://truenas.local",
        "TRUENAS_API_KEY": "your-api-key"
      }
    }
  }
}

Then open the Copilot chat panel, switch to Agent mode, and the truenas server will appear in the available tools.

Claude Desktop

Add the server to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):```json
{
"mcpServers": {
"truenas": {
"command": "/path/to/truenas-mcp",
"env": {
"TRUENAS_API_URL": "https://truenas.local",
"TRUENAS_API_KEY": "your-api-key"
}
}
}
}


Restart Claude Desktop after saving the config.

### OpenCode

Add the server to `opencode.json` in your project root (or `~/.config/opencode/opencode.json` for global config):```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "truenas": {
      "type": "local",
      "command": ["/path/to/truenas-mcp"],
      "enabled": true,
      "environment": {
        "TRUENAS_API_URL": "https://truenas.local",
        "TRUENAS_API_KEY": "your-api-key"
      }
    }
  }
}

Agent skills

The skills/ directory contains Agent Skills (SKILL.md format) that teach an agent how to use these tools well:

Skill Use it for
truenas Everyday tasks: pool and dataset usage, snapshots, app installs and upgrades, VM lifecycle and devices — with safe confirmation rules
audit-truenas A read-only health review (pools, capacity, snapshot coverage, app upgrade backlog, VMs) that produces a prioritised findings report
pbs-on-truenas Set up Proxmox Backup Server in a TrueNAS VM and register it with Proxmox VE, together with proxmox-mcp

Install them for all your projects in Claude Code:```bash
git clone https://github.com/gordcurrie/truenas-mcp
mkdir -p ~/.claude/skills
cp -R truenas-mcp/skills/* ~/.claude/skills/


Other agents that support Agent Skills (GitHub Copilot, Cursor, Codex CLI, Gemini CLI, …) read the same folders; copy them to that agent's skills directory. Inside this repo they are already available to Claude Code and Copilot via `.claude/skills` and `.github/skills`, which link to `skills/`.

## Development```bash
make install-tools   # install golangci-lint, gosec, govulncheck, gofumpt
make check           # full quality gate: fix, fmt, vet, lint, sec, vulncheck, test, build
make test            # tests only (with race detector)
make build           # build only → bin/truenas-mcp
make clean           # remove bin/truenas-mcp

常见问题

6 问
答案由本站依据条目字段整理,不引用上游原文
Truenas MCP Fbb18a15 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

Truenas MCP Fbb18a15 怎么在 Claude Desktop、Claude 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Truenas MCP Fbb18a15 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Truenas MCP Fbb18a15 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Truenas MCP Fbb18a15 支持哪些客户端?

资料标注支持 Claude Desktop、Claude;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Truenas MCP Fbb18a15 能提供哪些能力?

资料显示约 36 个工具;能力标签包括 系统管理、Go、Claude、网络管理。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。