Skip to main content
Glama
profanter-dev

truenas-mcp

by profanter-dev
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Remote

truenas-mcp

Read-only MCP server for TrueNAS SCALE 25.10+ — connects via the JSON-RPC 2.0 WebSocket API.

Why this exists: The official truenas/truenas-mcp binary uses the legacy DDP protocol, which was removed in TrueNAS 25.10. This server targets the new wss://host/api/current JSON-RPC 2.0 endpoint exclusively.

READ-ONLY: This server performs zero write or mutating operations.

Requirements

  • TrueNAS SCALE 25.10 or later

  • A TrueNAS API key (generate in System → API Keys)

  • Node.js 18+

Related MCP server: KVMFleet MCP Server

Install

npm install -g @profanter-dev/truenas-mcp

Or run without installing:

npx @profanter-dev/truenas-mcp

Configuration

Variable

Required

Description

TRUENAS_HOST

✓

host:port, e.g. 192.168.1.29:444

TRUENAS_API_KEY

✓

TrueNAS API key

TRUENAS_INSECURE

true to skip TLS certificate verification (self-signed certs)

Copy .env.example to .env and fill in your values, or pass as environment variables.

Claude Code setup

claude mcp add truenas \
  -e TRUENAS_HOST=192.168.1.29:444 \
  -e TRUENAS_API_KEY=your-key \
  -e TRUENAS_INSECURE=true \
  -- npx @profanter-dev/truenas-mcp

Tools

All entities follow a consistent list / details pattern.

Storage

Tool

Description

pool_list

All ZFS pools — health, status, usable capacity (used + available)

pool_details

Single pool: health, capacity, last scrub

disk_list

All disks — model, type, pool assignment, temperature, SMART result, ZFS error counts

disk_details

Single disk: serial, size, temperature, full SMART history, vdev assignment, ZFS errors

dataset_list

All ZFS datasets with used/available space; optionally filter by pool

dataset_details

Full properties for a single dataset: compression, dedup, quota, and more

snapshot_list

ZFS snapshots ordered newest-first; filter by dataset, configurable limit, boot-pool excluded by default

snapshot_details

Single snapshot: size, referenced, compression ratio, clones

Shares

Tool

Description

share_list

All SMB and NFS shares — path, enabled state, comment

share_details

Full config for a single SMB or NFS share

Services

Tool

Description

service_list

All TrueNAS services with running state and boot-enable flag

service_details

Single service state plus service-specific config (e.g. SSH port and auth settings, SMB workgroup, NFS settings). Private/public key material is stripped.

System

Tool

Description

system_info

Hostname, version, CPU, memory, uptime, load average (1/5/15 min), timezone

Jobs & Alerts

Tool

Description

job_list

Unique job types with last-run status and timestamp (cron jobs shown with human-readable description)

job_history

Full run history for a specific job; requires description (from job_list) and limit

alert_list

Active alerts sorted by severity: CRITICAL → ERROR → WARNING → NOTICE → INFO

Protocol details

  • WebSocket URL: wss://<host>/api/current

  • Auth: auth.login_with_api_key — called once on connect; never reconnects per-call

  • Rate limit: TrueNAS enforces 20 auth attempts per 60 s; exceeding triggers a 10-minute lockout

  • The server maintains a single persistent connection with exponential-backoff reconnection on unexpected disconnects

This server cannot be installed

F
license - not found
-
quality - not tested
A
maintenance

How are these scores calculated?

Maintenance

–Maintainers
–Response time
–Release cycle
1Releases (12mo)
Commit activity

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/profanter-dev/truenas-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server