Truenascoremcp

🚀 TrueNAS Core MCP Server

このModel Context Protocol (MCP)サーバーは、Claude Desktop（または任意のMCPクライアント）がTrueNAS APIを介してTrueNAS Coreシステムと相互作用できるようにします。

✨ 主な機能

• ユーザー管理：ユーザーを一覧表示し、ユーザーの詳細を取得します。
• システム情報：TrueNASシステムの情報を取得します。
• ストレージ管理：プール、データセットを一覧表示し、データセットを作成します。
• 共有：SMB共有を一覧表示し、作成します。
• スナップショット：ZFSスナップショットを作成します。

📦 インストール

前提条件

• Python 3.8以上
• APIアクセスが可能なTrueNAS Coreシステム
• Claude Desktop（またはMCP互換のクライアント）
• TrueNAS APIキー

インストール手順

1. このリポジトリをクローンします：

git clone https://github.com/vespo92/TrueNasCoreMCP.git
cd truenas-core-mcp

2. 仮想環境を作成します：

python -m venv venv

# Windowsの場合:
venv\Scripts\activate

# Linux/Macの場合:
source venv/bin/activate

3. 依存関係をインストールします：

pip install -r requirements.txt

4. 環境変数を設定します：

cp .env.example .env
# .envを編集し、TrueNASの詳細を入力します

TrueNAS APIキーの取得方法

1. TrueNAS CoreのWebインターフェイスにログインします。
2. 設定 → APIキーに移動します。
3. 追加をクリックします。
4. キーに名前を付けます（例："MCP Server"）。
5. 送信をクリックします。
6. 生成されたAPIキーをコピーします（再度表示できません！）。

設定

.envファイルを編集し、TrueNASの接続詳細を入力します：

TRUENAS_URL=https://192.168.1.100  # あなたのTrueNASのIPまたはホスト名
TRUENAS_API_KEY=1-your-api-key-here
TRUENAS_VERIFY_SSL=false  # 有効なSSL証明書を使用する場合はtrueに設定

サーバーの起動

スタンドアロンモード（テスト用）

python truenas_mcp_server.py

Claude Desktopとの連携

1. Claude Desktopの設定を開きます。
2. MCPサーバーの設定に移動します。
3. claude_desktop_config.jsonに以下の設定を追加します：

{
  "mcpServers": {
    "truenas": {
      "command": "python",
      "args": [
        "C:\\path\\to\\truenas_mcp_server.py"
      ],
      "env": {
        "TRUENAS_URL": "https://your-truenas-ip",
        "TRUENAS_API_KEY": "your-api-key",
        "TRUENAS_VERIFY_SSL": "false"
      }
    }
  }
}

4. Claude Desktopを再起動します。

💻 使用例

利用可能な関数

ユーザー管理

• list_users() - システム内のすべてのユーザーを一覧表示します。
• get_user(username) - 特定のユーザーの詳細情報を取得します。

システム情報

• get_system_info() - TrueNASシステムの情報を取得します。

ストレージ管理

• list_pools() - すべてのストレージプールを一覧表示します。
• list_datasets() - すべてのデータセットを一覧表示します。
• get_pool_status(pool_name) - 特定のプールの詳細な状態を取得します。
• create_dataset(pool, name, compression="lz4", quota=None) - 新しいデータセットを作成します。

共有

• list_smb_shares() - すべてのSMB共有を一覧表示します。
• create_smb_share(path, name, comment="", read_only=False) - 新しいSMB共有を作成します。

スナップショット

• create_snapshot(dataset, name, recursive=False) - ZFSスナップショットを作成します。

Claudeでの使用例

設定が完了したら、Claudeに以下のような要求をすることができます：

• "TrueNASシステム内のすべてのユーザーを一覧表示して"
• "ストレージプールを表示して"
• "'tank'プールに'backups'という名前の新しいデータセットを作成して"
• "すべてのSMB共有を一覧表示して"
• "tank/dataのスナップショットを作成して"

🔧 技術詳細

セキュリティに関する考慮事項

• APIキー：APIキーを安全に保管し、バージョン管理システムにコミットしないでください。
• SSL検証：本番環境ではSSL検証を有効にしてください。
• ネットワークセキュリティ：TrueNASシステムが信頼できるネットワークからのみアクセス可能であることを確認してください。
• パーミッション：APIキーは、それを作成したユーザーと同じパーミッションを持ちます。

トラブルシューティング

接続問題

• TrueNASのURLが正しいことを確認します（https://を含む）。
• TrueNASでAPIサービスが有効になっていることを確認します。
• APIキーが有効であることを確認します。
• 自己署名証明書を使用する場合は、TRUENAS_VERIFY_SSL=falseに設定します。

APIエラー

• TrueNASのログを確認し、詳細なエラーメッセージを確認します。
• ユーザーが適切なパーミッションを持っていることを確認します。
• APIエンドポイントがTrueNAS Coreのバージョンと互換性があることを確認します。

🤝 コントリビューション

コントリビューションは大歓迎です！プルリクエストを送信してください。

📄 ライセンス

MITライセンス - 詳細はLICENSEファイルを参照してください。

🙏 謝辞

• 公式APIを使用してTrueNAS Core用に構築されました。
• AnthropicのModel Context Protocol (MCP)を使用しています。
• FastMCPを使用して簡単にMCPサーバーを作成しています。