Truenascoremcp

🚀 TrueNAS Core MCP 服務器

TrueNAS Core MCP 服務器是一個基於模型上下文協議（MCP）的服務器，它藉助 TrueNAS API 讓 Claude Desktop（或其他任何 MCP 客戶端）能夠與 TrueNAS Core 系統進行交互。

🚀 快速開始

本服務器使用 MCP 協議，讓 Claude Desktop 等客戶端能與 TrueNAS Core 系統交互。先完成安裝和配置，再啟動服務器，即可使用 Claude 調用相關功能。

✨ 主要特性

• 用戶管理：列出用戶、獲取用戶詳細信息
• 系統信息：獲取 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
# 使用你的 TrueNAS 詳細信息編輯 .env 文件

🔍 獲取 TrueNAS API 密鑰

1. 登錄你的 TrueNAS Core 網絡界面。
2. 導航至 設置 → API 密鑰。
3. 點擊 添加。
4. 為你的密鑰命名（例如，“MCP 服務器”）。
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 文件。

🙏 致謝

• 基於 TrueNAS Core 官方 API 構建。
• 使用了 Anthropic 的模型上下文協議（MCP）。
• 藉助 FastMCP 輕鬆創建 MCP 服務器。