Aerith Admin (RBAC Dashboard)

🚀 Aerith 教程服務器文檔

Aerith 教程服務器是一款基於模型、控制器、呈現器架構的工具，主要幫助開發人員管理和執行與教程相關的任務。它借鑑了 MANUS 方法，把教程拆分成具體步驟和子任務來達成目標。

🚀 快速開始

安裝說明

項目結構

your-project/
├── .aerith/                  # 存儲 Aerith 教程服務器的數據和日誌
│   └── instructions/        # 包含所有教程指令的 JSON 文件
└── README.md                 # 項目的文檔文件

環境變量

• MCP_DEBUG=true：啟用調試日誌記錄（在開發環境中默認設置）。
• 其他環境變量可以根據需要進行配置。

啟動服務器

# 啟動服務器
python3 -m aerith.server

# 訪問 Web 界面
打開瀏覽器訪問 http://localhost:8000

✨ 主要特性

• 指令管理：可創建、獲取和管理教程指令。
• 工作流程步驟：涵蓋任務計劃、信息收集、分析與編排以及最終報告生成等功能。
• 瀏覽器自動化：能自動執行特定的瀏覽器操作以實現目標。
• 文件系統工具：提供目錄結構查看、文件內容獲取等實用功能。
• Git 工具集成：支持 Git 操作，如狀態查看、日誌記錄、分支管理等。

📦 安裝指南

項目結構

your-project/
├── .aerith/                  # 存儲 Aerith 教程服務器的數據和日誌
│   └── instructions/        # 包含所有教程指令的 JSON 文件
└── README.md                 # 項目的文檔文件

環境變量

• MCP_DEBUG=true：啟用調試日誌記錄（在開發環境中默認設置）。
• 其他環境變量可以根據需要進行配置。

💻 使用示例

基本用法

# 啟動服務器
python3 -m aerith.server

# 訪問 Web 界面
打開瀏覽器訪問 http://localhost:8000

高級用法

指令管理

• create_instruction(title, description, goal, priority)：創建一個新的教程指令。
• get_instruction(instruction_id)：獲取指定 ID 的教程指令。

工作流程步驟

• create_task_plan(instruction_id, subtasks)：將指令分解為具體的子任務。
• gather_information(instruction_id, sources)：從各種來源收集信息。
• analyze_and_orchestrate(instruction_id, analysis, execution_plan)：分析數據並制定執行計劃。
• execute_step(instruction_id, step_id, execution_details)：執行計劃中的具體步驟。
• generate_final_report(instruction_id, include_details)：生成包含詳細內容的最終報告。

瀏覽器自動化

• run_browser_agent(goal)：運行瀏覽器代理以實現特定目標。

文件系統工具

• tree_directory(directory_path, max_depth, show_files, show_hidden, pattern, exclude_common, custom_excludes)：生成指定目錄的樹狀結構視圖，類似於 Unix 系統中的 tree 命令。

Git 工具

• git_status(detailed)：顯示工作區的狀態。
• git_log(count, show_stats, path, author, since, until)：顯示提交日誌。
• git_diff(file_path, staged, commit, compare_with)：顯示指定文件或提交之間的差異。
• git_branch(create, delete, remote, branch_name, base_branch)：列出、創建或刪除分支。
• git_checkout(branch_name, create, force)：切換分支或恢復工作區文件。
• git_commit(message, all_changes, amend)：記錄對倉庫的更改。
• git_push(remote, branch, force, tags)：更新遠程引用及相關對象。
• git_pull(remote, branch, rebase)：從另一個倉庫獲取併合並最新更改。
• git_add(paths)：將文件內容添加到暫存區。

📚 詳細文檔

數據存儲

所有教程指令及相關數據均存儲在 JSON 文件中，位於 .aerith/instructions 目錄下。

資源

文件資源

• file://{path}：通過路徑獲取文件內容。
• project://structure：獲取項目結構的字典表示。

教程資源

• instructions://list：獲取所有教程指令的列表。

日誌記錄

日誌存儲在 .aerith/logs/mcp_server.log 文件中，並輸出到標準錯誤流。當 MCP_DEBUG=true 時（開發環境默認啟用），將啟用詳細的調試日誌記錄。

📄 許可證

Aerith 教程服務器採用 MIT 許可證