nasbridge

nasbridge — control TrueNAS from Claude

An MCP server for TrueNAS that lets Claude Desktop, Claude Code, Cursor or any other MCP client manage your NAS — ZFS pools and datasets, SMB and NFS shares, snapshots, replication, VMs, alerts and network config. 278 actions in all.

Ask for "a dataset on tank with lz4 and a daily snapshot task", or "which pools are degraded", and it happens over the wire rather than through the web UI.

TrueNAS 26 drops the REST API in favour of JSON-RPC 2.0 over WebSocket, so this server speaks that transport directly.

One tool, not 278

The design decision worth stealing: this exposes a single hierarchical truenas tool rather than one tool per action.

Most MCP servers register a flat tool per operation. At 278 actions that consumes a large share of the context window before the model has done any work, and degrades tool selection as the list grows. Here the model discovers categories, lists the actions in one, then executes with parameters — three cheap round trips instead of a permanently expensive tool manifest.

How it works

This started as a fork of the truenas-mcp package, which targets the REST API that TrueNAS 26 removed. The tool handlers are largely unchanged — they still call a REST-style client (client.get/post/put/delete). What was rewritten is everything beneath: a path-translator maps each REST path to its JSON-RPC method (GET /pool becomes pool.query, PUT /pool/id/1 becomes pool.update), and a ws client sends those calls over a single authenticated WebSocket connection.

Keeping the REST-shaped seam meant the 278 handlers did not have to be rewritten to change transport.

Authentication is auth.login_with_api_key on connect. The connection keeps itself alive with a 30s core.ping. Long-running operations are tracked via core.get_jobs.

Tools

The truenas tool takes category, action and params:

• No args or category="help" — list all categories with action counts
• category only — list the actions in that category and their parameters
• category + action + params — execute

278 actions are wired across 18 categories:

Category	Covers
system	System info, services, mail, API keys, power, NTP, config backup
storage	Pools, datasets, snapshots, periodic snapshot tasks
sharing	SMB, NFS and iSCSI (targets, extents, portals, initiators)
network	Interfaces, global config, static routes, IPMI, staged changes
account	Users, groups and privileges
disk	Physical disks, SMART tests, temperatures, wipe
vm	Virtual machines and VM devices
app	Apps (install, upgrade, rollback, images) and Docker config
update	System updates, boot environments, boot pool
certificate	TLS certificates, ACME servers and DNS authenticators
alert	System alerts and alert notification services
data_protection	Replication, cloud sync/backup, cron, rsync, init/shutdown scripts, SSH credentials
filesystem	stat, listdir, mkdir, permissions, ACLs, ownership
reporting	Reporting config, graphs and time-series data
directory	Directory services (AD, LDAP) and Kerberos
service_config	SSH, FTP, SNMP and UPS config, system tunables
audit	Audit log queries and audit config
api	truenas_api_call, a raw escape hatch for any endpoint the other actions don't cover

Destructive actions (reboot, shutdown and similar) require an explicit confirm: true parameter.

Resources

Read-only resources surface common state without a tool call: truenas://system/info, truenas://storage/pools, truenas://storage/datasets, truenas://services, truenas://alerts, truenas://network/summary, truenas://sharing, truenas://vms, truenas://apps, truenas://disks, truenas://boot/environments and truenas://system/update.

Secrets are redacted

TrueNAS returns credentials in plain text to an admin API key, and anything a tool returns lands in the model's context. So every tool result, error message and resource passes through one redaction step before it leaves the server. Cloud sync provider keys, SSH and TLS private keys, password hashes, bind passwords, CHAP secrets and alert service tokens all come back as "[redacted]". Private key blocks, URL passwords and secret query parameters are scrubbed from any string, whatever field holds them.

Identifiers stay, so the model can still tell which credential a task uses: credential id and name, provider type, bucket, folder, endpoint and region. Public keys and certificates stay too.

Redaction applies to output only. Handlers still send real values to TrueNAS, so an update can never write [redacted] back as a credential.

api_key_create and keychaincredential_generate_ssh_key can no longer show the secret they create, so make API keys and SSH keypairs in the TrueNAS UI. Secrets passed in as parameters are not redacted, because the model wrote them in the first place.

Configuration

Variable	Required	Default	Notes
TRUENAS_URL	yes	—	TrueNAS host or URL. http:///https:// is rewritten to wss://; /api/current is appended if absent
TRUENAS_API_KEY	yes	—	Generate in TrueNAS: Credentials → API Keys → Add
TRUENAS_VERIFY_SSL	no	true	Set false to skip TLS verification (self-signed certs)

The client connects with wss:// by default. A self-signed cert needs TRUENAS_VERIFY_SSL=false.

Don't pass a ws:// URL. http:// and https:// are rewritten to wss://, but an explicit ws:// is left alone — and TrueNAS auto-revokes any API key it sees used over an insecure transport. You get an authentication failure that looks like a bad key, and the key really is dead. Regenerate it and connect over wss://.

Requirements

• TrueNAS 26 or later (earlier versions expose a different WebSocket shape)
• Node.js 18+ (CI proves the built server imports on 18 and 22)
• A TrueNAS API key — Credentials → API Keys → Add
• An MCP client: Claude Desktop, Claude Code, Cursor, or anything else speaking MCP

Install and run

nasbridge is on npm, so there is nothing to clone or build:

TRUENAS_URL=https://truenas.local TRUENAS_API_KEY=1-yourkey npx -y nasbridge

Create the API key in the TrueNAS UI under Credentials → Local Users → API Keys. Keep it in your MCP client config or a local .env, never in the repo — .env is gitignored for that reason.

The server speaks MCP over stdio. Add it to your MCP client config — for Claude Desktop that is claude_desktop_config.json, for Claude Code .mcp.json:

{
  "command": "npx",
  "args": ["-y", "nasbridge"],
  "env": {
    "TRUENAS_URL": "https://truenas.local",
    "TRUENAS_API_KEY": "1-yourkey",
    "TRUENAS_VERIFY_SSL": "false"
  }
}

From source

git clone https://github.com/maverick0628/nasbridge.git
cd nasbridge
npm install
npm run build

Then point your client at node /path/to/nasbridge/dist/cli.js instead of npx.

Tests

npm test

Unit tests cover the REST-to-WebSocket path translator, the dataset property normalisation, the client against a mock WebSocket server and secret redaction against fixtures shaped like real TrueNAS responses. test/e2e-live.mjs runs the dataset create/get flow against a real TrueNAS instance.

Notes

TrueNAS 26 tightened dataset validation: atime, compression and sync must be uppercase string literals (ON, OFF, LZ4, STANDARD). The storage tools normalise these before create/update, so the model can pass natural values.

Built against TrueNAS 26. Earlier versions expose a different WebSocket API shape and are not supported.

License

MIT — see LICENSE.