Aerith Admin (RBAC Dashboard)

🚀 Aerith Tutorial Server Documentation

Aerith Tutorial Server is a tool based on the model, controller, and renderer architecture. It aims to assist developers in managing and executing tutorial - related tasks. It draws inspiration from the MANUS method (assumed to be a certain project management method) and achieves its goals by breaking down tutorials into specific steps and subtasks.

🚀 Quick Start

Installation

Project Structure

your-project/
├── .aerith/                  # Store data and logs of Aerith Tutorial Server
│   └── instructions/        # JSON files containing all tutorial instructions
└── README.md                 # Project documentation file

Environment Variables

• MCP_DEBUG=true: Enable debug logging (default setting in the development environment).
• Other environment variables can be configured as needed.

Usage

Basic Usage

# Start the server
python3 -m aerith.server

# Access the Web interface
Open your browser and visit http://localhost:8000

✨ Features

• Instruction Management: Create, retrieve, and manage tutorial instructions.
• Workflow Steps: Include functions such as task planning, information gathering, analysis and orchestration, and final report generation.
• Browser Automation: Automatically perform specific browser operations to achieve goals.
• File System Tools: Provide useful functions like viewing directory structures and retrieving file contents.
• Git Tool Integration: Support Git operations such as viewing status, logging, and branch management.

📦 Installation

Project Structure

your-project/
├── .aerith/                  # Store data and logs of Aerith Tutorial Server
│   └── instructions/        # JSON files containing all tutorial instructions
└── README.md                 # Project documentation file

Environment Variables

• MCP_DEBUG=true: Enable debug logging (default setting in the development environment).
• Other environment variables can be configured as needed.

💻 Usage Examples

Basic Usage

# Start the server
python3 -m aerith.server

# Access the Web interface
Open your browser and visit http://localhost:8000

Key Tools

Instruction Management

• create_instruction(title, description, goal, priority): Create a new tutorial instruction.
• get_instruction(instruction_id): Retrieve a tutorial instruction with the specified ID.

Workflow Steps

• create_task_plan(instruction_id, subtasks): Break down an instruction into specific subtasks.
• gather_information(instruction_id, sources): Gather information from various sources.
• analyze_and_orchestrate(instruction_id, analysis, execution_plan): Analyze data and formulate an execution plan.
• execute_step(instruction_id, step_id, execution_details): Execute a specific step in the plan.
• generate_final_report(instruction_id, include_details): Generate a final report with detailed content.

Browser Automation

• run_browser_agent(goal): Run a browser agent to achieve a specific goal.

File System Tools

• tree_directory(directory_path, max_depth, show_files, show_hidden, pattern, exclude_common, custom_excludes): Generate a tree - like view of the specified directory, similar to the tree command in Unix systems.

Git Tools

• git_status(detailed): Show the status of the working directory.
• git_log(count, show_stats, path, author, since, until): Show commit logs.
• git_diff(file_path, staged, commit, compare_with): Show differences between specified files or commits.
• git_branch(create, delete, remote, branch_name, base_branch): List, create, or delete branches.
• git_checkout(branch_name, create, force): Switch branches or restore working directory files.
• git_commit(message, all_changes, amend): Record changes to the repository.
• git_push(remote, branch, force, tags): Update remote references and related objects.
• git_pull(remote, branch, rebase): Fetch and merge the latest changes from another repository.
• git_add(paths): Add file contents to the staging area.

📚 Documentation

Data Storage

All tutorial instructions and related data are stored in JSON files located in the .aerith/instructions directory.

Resources

File Resources

• file://{path}: Retrieve file contents by path.
• project://structure: Get a dictionary representation of the project structure.

Tutorial Resources

• instructions://list: Get a list of all tutorial instructions.

Logging

Logs are stored in the .aerith/logs/mcp_server.log file and output to the standard error stream. When MCP_DEBUG=true (enabled by default in the development environment), detailed debug logging is enabled.

📄 License

MIT License