定制开发¶

欢迎来到 UCAgent 定制开发指南！本章节将帮助您了解如何定制和扩展 UCAgent 的功能。

本章内容¶

UCAgent 提供了灵活的定制能力，您可以根据项目需求进行以下定制：

🚀 快速开始 ¶

快速上手 UCAgent 的定制开发：

MiniWorkflow 示例：完整的文档生成工作流示例
从零开始：创建自定义工作流、工具、检查器的步骤
代码示例：可直接运行的完整示例代码

适合初次接触 UCAgent 定制开发的用户。

🏗️ 架构与工作原理 ¶

深入理解 UCAgent 的内部架构：

核心组件：Stage Manager、Tools、Checkers、Templates
配置体系：三层配置优先级（系统/用户/项目）
工作流程：从配置加载到任务执行的完整流程

适合想要深入了解 UCAgent 架构的开发者。

⚙️ 工作流配置 ¶

深入理解 UCAgent 的验证工作流：

11 个标准阶段：从需求分析到验证总结的完整流程
阶段跳过控制：通过配置文件或命令行控制阶段执行
自定义工作流：修改和扩展默认工作流
配置文件结构：config.yaml 的详细说明
MiniWorkflow 示例：完整的工作流配置示例

适合需要调整验证流程、优化工作流的用户。

📝 模板文件与生成产物 ¶

了解 UCAgent 的模板文件系统和输出结构：

模板文件（Guide_Doc）：指导 AI 生成规范文档和测试代码的参考文档
生成产物结构：output/ 目录下的文件组织方式
模板文件说明：各类模板的用途和对应的输出文件
MiniWorkflow 示例：如何创建自定义模板文件

适合想要理解 UCAgent 工作机制和调整文档规范的用户。

🛠️ 定制工具 ¶

学习如何添加和集成自定义工具：

添加新工具：创建继承自 UCTool 的自定义工具
MCP Server 集成：将工具暴露为 MCP Server 工具
工具注册：通过配置文件和命令行参数注册外部工具
Checker 检查器：编写自定义检查器验证输出质量
MiniWorkflow 示例：完整的自定义工具实现

适合需要扩展 UCAgent 功能、集成领域专用工具的开发者。

📚 工具列表 ¶

UCAgent 内置工具的完整参考：

基础/信息类工具：角色信息、求助等
规划/ToDo 类：任务管理工具
文件操作类：读写、搜索、路径处理
文档/记忆类：参考检索、记忆管理
阶段控制类：阶段跳转、提示获取

适合查阅可用工具及其参数的用户。

✅ 检查器 ¶

了解如何使用和编写检查器：

检查器作用：验证阶段输出质量
内置检查器：格式检查、业务验证等
自定义检查器：编写领域专用的验证逻辑

适合需要定制验证规则的用户。

🎯 Mini示例 ¶

通过完整示例学习定制开发：

计算器文档生成器：完整的工作流实现
自定义工具：CountWords、ExtractSections
自定义检查器：WordCount、RequiredSections
可运行代码：examples/MiniWorkflow/

适合通过实践学习的用户。

学习路径建议¶

快速入门¶

先阅读快速开始快速了解定制开发
查看 Mini示例理解完整工作流
浏览工具列表了解可用的内置工具

深度定制¶

理解架构与工作原理掌握核心概念
学习工作流配置定制验证流程
学习定制工具开发自定义功能
查看实际案例：examples/

定制开发¶

本章内容¶

🚀 快速开始¶

🏗️ 架构与工作原理¶

⚙️ 工作流配置¶

📝 模板文件与生成产物¶

🛠️ 定制工具¶

📚 工具列表¶

✅ 检查器¶

🎯 Mini示例¶