Skip to main content
Glama
spranab

truenas-mcp

by spranab

truenas-mcp

npm npm downloads

NASをAIアシスタントに組み込む場合、通常は操作ごとにMCPツールを1つ登録することになります。TrueNAS SCALEをきちんとカバーしようとすると、50〜80個のツールスキーマが必要になり、モデルが質問を1文字も読む前に、毎回のリクエストで約28,000トークンのコンテキストウィンドウを消費します。ストレージに触れるかどうかに関係なくです。

truenas-mcpは、TrueNAS SCALE REST API全体である18カテゴリにわたる278のアクションを、約200トークンしか消費しない1つの階層型ツールの背後でカバーします。モデルはどのカテゴリが存在するかを尋ね、必要なカテゴリにドリルダウンし、その後アクションを呼び出します。破壊的な操作は、confirm: true なしでは実行を拒否します。

インストール(60秒)

# No install needed
TRUENAS_URL=https://truenas.local TRUENAS_API_KEY=1-abc123 npx truenas-mcp

Claude Code:

claude mcp add truenas -- npx -y truenas-mcp   --env TRUENAS_URL=https://truenas.local   --env TRUENAS_API_KEY=1-your-api-key-here

APIキーはTrueNAS UIから取得します:Settings > API Keys > Add

Related MCP server: Proxmox MCP Server

動作イメージ

あなた: 「プールは健全ですか?mediaデータセット用にNFS共有を作成できますか?」

→ truenas({ category: "storage", action: "pool_list" })
  tank — ONLINE, 68% used, 0 errors

→ truenas({ category: "sharing", action: "nfs_share_create",
            params: { path: "/mnt/tank/media", comment: "Media share" } })

モデルは、最初に truenas({ category: "sharing" }) を呼び出すことで nfs_share_create を発見しました。36個の共有アクションはプロンプトに含まれていません。

なぜ278個ではなく1つのツールなのか

truenas-mcp

一般的なNAS MCPサーバー

アクション

278

5〜80

トークン消費量

~200トークン(1ツール)

5,000〜30,000トークン(50〜80ツール)

発見方法

階層型 — 必要なものを尋ねる

フラット — すべてを事前に読み込む

MCPリソース

読み取り専用ダッシュボード12個

0

インストール

npx truenas-mcp

ソースからビルド / pip

安全性

破壊的操作には confirm: true が必要

さまざま

完全な設定

# Using npx (no install needed)
TRUENAS_URL=https://truenas.local TRUENAS_API_KEY=1-abc123 npx truenas-mcp

# Or install globally
npm install -g truenas-mcp

環境変数

変数

必須

説明

TRUENAS_URL

はい

TrueNASインスタンスのURL(例:https://truenas.local

TRUENAS_API_KEY

はい

TrueNAS UIから取得するAPIキー:Settings > API Keys > Add

TRUENAS_VERIFY_SSL

いいえ

false に設定するとSSL検証をスキップ(自己署名証明書用)

Claude Desktopの設定

claude_desktop_config.json に追加します:

{
  "mcpServers": {
    "truenas": {
      "command": "npx",
      "args": ["-y", "truenas-mcp"],
      "env": {
        "TRUENAS_URL": "https://truenas.local",
        "TRUENAS_API_KEY": "1-your-api-key-here",
        "TRUENAS_VERIFY_SSL": "false"
      }
    }
  }
}

Claude Code

claude mcp add truenas -- npx -y truenas-mcp \
  --env TRUENAS_URL=https://truenas.local \
  --env TRUENAS_API_KEY=1-your-api-key-here \
  --env TRUENAS_VERIFY_SSL=false

仕組み — 階層型ツール設計

278個の個別ツールを登録する代わりに(LLMのシステムプロンプトで約30kトークンを消費する)、このサーバーは**truenas という1つのツール**を3つの使用モードで公開します:

1. カテゴリを発見

truenas()

説明とアクション数を含む全18カテゴリを返します(約200トークン)。

2. カテゴリを探索

truenas({ category: "storage" })

そのカテゴリの全アクションを、必須/任意パラメータとともに返します。

3. アクションを実行

truenas({ category: "storage", action: "pool_list" })
truenas({ category: "storage", action: "dataset_create", params: { name: "tank/media", compression: "LZ4" } })

つまり、LLMは実際に使用する分のトークンコストしか支払いません。

カテゴリ

カテゴリ

アクション数

対象

system

24

システム情報、設定、サービス、メール、APIキー、NTP

storage

32

プール、データセット、スナップショット、定期スナップショットタスク

sharing

36

SMB/CIFS、NFSエクスポート、iSCSIターゲット/エクステント/ポータル/イニシエーター

network

15

インターフェース、グローバル設定、静的ルート、IPMI、ステージングされた変更

account

16

ユーザー、グループ、権限/ロール

disk

7

物理ディスク、SMARTテスト、温度

vm

16

仮想マシン、VMデバイス(ディスク、NIC、ディスプレイ、PCI)

app

17

Dockerアプリ、コンテナランタイム設定

update

14

システムアップデート、ブート環境、ブートプール

certificate

8

TLS証明書、ACME/Let's Encrypt、DNS認証子

alert

10

アラート、通知サービス(Slack、メール、PagerDuty)

data_protection

49

レプリケーション、クラウド同期、クラウドバックアップ、cron、rsync、初期化スクリプト、SSHキー

filesystem

7

stat、listdir、mkdir、パーミッション、ACL、chown

reporting

3

メトリクス設定、グラフ、時系列データ

directory

8

Active Directory、LDAP、Kerberos

service_config

12

SSH、FTP、SNMP、UPS、システムチューナブル

audit

3

監査ログ、監査設定

api

1

任意のエンドポイント用の生APIエスケープハッチ

MCPリソース(12個)

ダッシュボード用の読み取り専用リソース — ツール呼び出しは不要です:

リソース

URI

説明

システム情報

truenas://system/info

バージョン、ホスト名、稼働時間、ハードウェア

プール

truenas://storage/pools

容量と健全性を含む全プール

データセット

truenas://storage/datasets

プロパティを含む全データセット

サービス

truenas://services

サービスステータスの概要

アラート

truenas://alerts

現在のシステムアラート

ネットワーク

truenas://network/summary

インターフェース、IP、DNS、ゲートウェイ

共有

truenas://sharing

すべてのSMB、NFS、iSCSI共有

VM

truenas://vms

ステータス付きの仮想マシン

アプリ

truenas://apps

インストール済みアプリケーション

ディスク

truenas://disks

物理ディスク情報

ブート環境

truenas://boot/environments

ブート環境

アップデート

truenas://system/update

アップデート設定

会話例

「どんなプールを持っていて、それらは健全ですか?」

→ truenas({ category: "storage", action: "pool_list" })

「/mnt/tank/media 用にNFS共有を作成してください」

→ truenas({ category: "sharing", action: "nfs_share_create", params: { path: "/mnt/tank/media", comment: "Media share" } })

「システムアップデートを確認してください」

→ truenas({ category: "update", action: "update_check" })

「sda でどのSMARTテストが実行されましたか?」

→ truenas({ category: "disk", action: "disk_smart_test_list", params: { disk: "sda" } })

安全性

すべての破壊的操作には、パラメータに confirm: true が必要です:

  • プールの作成/エクスポート/ディスク交換

  • データセット/スナップショットの削除、スナップショットのロールバック

  • VMの削除、アプリの削除/ロールバック

  • システムの再起動/シャットダウン、アップデートの適用

  • ディスクのワイプ、ブートディスクの接続/取り外し

  • 証明書の削除、ブート環境の削除

  • ディレクトリサービスの離脱、ACLの設定

confirm: true がない場合、これらのアクションは何が起こるかを説明するエラーメッセージを返します。

API互換性

TrueNAS SCALE REST API v2.0用に構築されています。TrueNAS SCALE 22.x〜25.xと互換性があります。

開発

git clone https://github.com/spranab/truenas-mcp
cd truenas-mcp
npm install
npm run build
npm run dev  # watch mode

関連プロジェクト

同じ作者による他のMCPサーバーおよびエージェントインフラストラクチャ:

  • mcpier — ホームラボ向けのセルフホスト型MCPコントロールプレーン。APIキーをクライアントから分離します。

  • saga-mcp — SQLiteバックアップのプロジェクトトラッカー。エージェントがセッション間で計画を失わないようにします。

  • yantrikdb-mcp — Claude Code、Cursor、Windsurf向けの永続的な認知メモリ。

  • swarmcode — 異なるマシン上のClaude Codeインスタンス間のリアルタイムチャネル。

  • brainstorm-mcp — MCPツールとしてのマルチモデルディベート。

ライセンス

MIT

A
license - permissive license
Not graded
quality - not tested
B
maintenance

Maintenance

Maintainers
23dResponse time
Release cycle
Releases (12mo)
Commit activity
Issues opened vs closed

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

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

Related MCP Servers

  • F
    license
    A
    quality
    D
    maintenance
    Enables Claude to monitor and manage homelab infrastructure including Docker containers, OPNsense firewall, and TrueNAS storage with configurable capability levels from read-only monitoring to full management control.
    13
    39
    6
  • A
    license
    C
    quality
    D
    maintenance
    Enables management of Proxmox VE infrastructure through natural language, providing 120+ tools to control virtual machines, containers, storage, cluster resources, users, and network configurations via the Proxmox API.
    100
    17
    MIT
  • F
    license
    Not graded
    quality
    D
    maintenance
    Enables AI agents to manage VMware vSphere virtual infrastructure through comprehensive operations including VM power control, snapshot management, resource monitoring, performance analytics, and bulk operations with built-in safety confirmations for destructive actions.
  • A
    license
    Not graded
    quality
    D
    maintenance
    Enables AI assistants to interact with Dell PowerScale (Isilon) OneFS clusters through over 2,400 tools generated from the REST API specification. It supports managing storage protocols, snapshots, networking, and cluster configurations using natural language.
    2
    MIT

View all related MCP servers

Related MCP Connectors

  • Let AI operate servers without SSH. Choose actions, approve risky changes, and audit every step.

  • Operate Linux, macOS and Windows from your LLM. Every action runs through an auditable allowlist.

  • SaaS intelligence for AI agents. 5 unified tools cover 1,000+ services with 91-96% token savings.

View all MCP Connectors

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/spranab/truenas-mcp'

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