truenas-mcp
Read-only MCP server for TrueNAS SCALE 25.10+ that connects via JSON-RPC 2.0 WebSocket API, providing tools to inspect storage, shares, services, system info, jobs, and alerts.
README
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-mcpbinary uses the legacy DDP protocol, which was removed in TrueNAS 25.10. This server targets the newwss://host/api/currentJSON-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+
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
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
E2B
Using MCP to run code via e2b.
Neon Database
MCP server for interacting with Neon Management API and databases
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.