Aerith 教程服务器文档

概述

Aerith 教程服务器是一个基于模型、控制器、呈现器架构的工具，旨在帮助开发人员管理和执行教程相关的任务。它借鉴了 MANUS 方法（假设为某种项目管理方法），通过将教程分解为具体的步骤和子任务来实现目标。

功能特点

• 指令管理：创建、获取和管理教程指令。
• 工作流程步骤：包括任务计划、信息收集、分析与编排以及最终报告生成等功能。
• 浏览器自动化：能够自动执行特定的浏览器操作以达成目标。
• 文件系统工具：提供目录结构查看、文件内容获取等实用功能。
• Git 工具集成：支持 Git 操作如状态查看、日志记录、分支管理等。

数据存储

所有教程指令及相关数据均存储在 JSON 文件中，位于 .aerith/instructions 目录下。

安装说明

项目结构

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)：将文件内容添加到暂存区。

资源

文件资源

• file://{path}：通过路径获取文件内容。
• project://structure：获取项目结构的字典表示。

教程资源

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

日志记录

日志存储在 .aerith/logs/mcp_server.log 文件中，并输出到标准错误流。当 MCP_DEBUG=true 时（开发环境默认启用），将启用详细的调试日志记录。

许可证

MIT License