跳转至

入门指南

这组文档面向第一次使用 jianmu 的开发者。

目标不是一次性解释全部模块，而是按一条递进路径，把下面几件事串起来：

  1. 先完成安装与运行前准备
  2. 跑通最小聊天 Agent
  3. 理解 ReAct 与 tool calling
  4. 理解 prompt 与 ContextBuilder
  5. 再回头理解配置系统
  6. 理解 HITL、suspend 与 resume
  7. 编写自定义 tool
  8. 使用并编写 prompt skill
  9. 用节点组合 Agent
  10. 写一个自定义 Node
  11. 理解并接入 memory
  12. 理解多智能体 swarm

文档和示例代码分开放置：

  • 文档：docs/getting_started/
  • 可运行示例：examples/getting_started/

阅读方式

建议按顺序阅读下面 13 步：

  1. 第 00 步：安装与准备
  2. 第 01 步：最小聊天 Agent
  3. 第 02 步：ReAct 与工具调用
  4. 第 03 步：Prompt 与 ContextBuilder
  5. 第 04 步：配置系统
  6. 第 05 步：Guard、HITL 与执行
  7. 第 06 步：编写自定义工具
  8. 第 07 步：使用 Skill
  9. 第 08 步：用节点组合 Agent
  10. 第 09 步：编写自定义节点
  11. 第 10 步：构建 BT Skill
  12. 第 11 步：记忆系统
  13. 第 12 步：多 Agent Swarm

学完之后你应该会什么

完成这组步骤后，你应该能：

  • 配好 jianmu 的基础运行环境
  • 用 Agent 和 create_react_node(...) 跑一个最小 Agent
  • 理解 messages / actions / done / final_answer / rounds 这些常见 State 字段
  • 理解 Prompt、默认配置和 ContextBuilder 的装配关系
  • 把 Python 函数或 Tool 子类接进 Agent
  • 分清“使用 skill”“写 prompt skill”“写 BT skill”三种不同层级
  • 区分 Tool、Skill、Node 三种扩展层
  • 知道记忆系统和 Swarm 分别解决什么问题
  • 知道什么时候应该转去 Tree Studio 或更底层的模块文档

这 13 步怎么分层

你可以把这套 Getting Started 分成三段：

  • 第 1 到 6 步：先会用框架和 HITL 主路径
  • 第 7 到 11 步：再会扩展框架
  • 第 12 到 13 步：最后进入长期记忆与多智能体

关于示例代码

当前 examples/getting_started/ 已经覆盖除 installation 说明外的主路径示例。

其中有几步的文档顺序已经前移或重命名：

  • step_01_minimal_chat 对应 step_01_minimal_chat.py
  • step_02_react_with_tool 对应 step_02_react_with_tool.py
  • step_03_prompt_and_context_builder 对应 step_03_prompt_and_context_builder.py
  • step_05_add_guard_and_execution 对应 step_05_add_guard_and_execution.py
  • step_06_build_custom_tool 对应 step_06_build_custom_tool.py
  • step_07_use_skill 对应 step_07_use_skill.py
  • step_08_compose_agent_from_nodes 对应 step_08_compose_agent_from_nodes.py
  • step_09_write_custom_node 对应 step_09_write_custom_node.py
  • step_10_build_bt_skill 对应 step_10_build_bt_skill.py
  • step_11_memory 对应 step_11_memory.py
  • step_12_multi_agent_swarm 对应 step_12_multi_agent_swarm.py

对照文档

如果你在某一步想直接看更完整的机制说明，可以跳转到：