goal_tool.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. """
  2. Goal 工具 - 计划管理
  3. 提供 goal 工具供 LLM 管理执行计划。
  4. """
  5. import logging
  6. from typing import Optional, List, TYPE_CHECKING
  7. from agent.tools import tool
  8. if TYPE_CHECKING:
  9. from .goal_models import GoalTree, Goal
  10. from .protocols import TraceStore
  11. logger = logging.getLogger(__name__)
  12. # ===== 知识注入 =====
  13. async def inject_knowledge_for_goal(
  14. goal: "Goal",
  15. tree: "GoalTree",
  16. store: Optional["TraceStore"] = None,
  17. trace_id: Optional[str] = None,
  18. knowledge_config: Optional[dict] = None,
  19. ) -> Optional[str]:
  20. """
  21. 为指定 goal 注入相关知识。
  22. Args:
  23. goal: 目标对象
  24. tree: GoalTree
  25. store: TraceStore(用于持久化)
  26. trace_id: Trace ID
  27. knowledge_config: 知识管理配置(KnowledgeConfig 对象)
  28. Returns:
  29. 注入结果描述(如 "📚 已注入 3 条相关知识"),无结果返回 None
  30. """
  31. # 检查是否启用知识注入
  32. if knowledge_config and not getattr(knowledge_config, 'enable_injection', True):
  33. logger.debug(f"[Knowledge Inject] 知识注入已禁用,跳过")
  34. return None
  35. try:
  36. from agent.tools.builtin.knowledge import knowledge_search
  37. logger.info(f"[Knowledge Inject] goal: {goal.id}, query: {goal.description[:80]}")
  38. # 从配置中获取搜索参数
  39. search_types = None
  40. search_owner = None
  41. if knowledge_config:
  42. search_types = getattr(knowledge_config, 'default_search_types', None)
  43. search_owner = getattr(knowledge_config, 'default_search_owner', None) or None
  44. knowledge_result = await knowledge_search(
  45. query=goal.description,
  46. top_k=3,
  47. min_score=3,
  48. types=search_types,
  49. owner=search_owner,
  50. context=None
  51. )
  52. logger.debug(f"[Knowledge Inject] result type: {type(knowledge_result)}, metadata: {getattr(knowledge_result, 'metadata', None)}")
  53. if knowledge_result.metadata and knowledge_result.metadata.get("items"):
  54. goal.knowledge = knowledge_result.metadata["items"]
  55. knowledge_count = len(goal.knowledge)
  56. logger.info(f"[Knowledge Inject] 注入 {knowledge_count} 条知识到 goal {goal.id}")
  57. if store and trace_id:
  58. await store.update_goal_tree(trace_id, tree)
  59. return f"📚 已注入 {knowledge_count} 条相关知识"
  60. else:
  61. goal.knowledge = []
  62. logger.info(f"[Knowledge Inject] 未找到相关知识")
  63. return None
  64. except Exception as e:
  65. logger.warning(f"[Knowledge Inject] 知识注入失败: {e}")
  66. goal.knowledge = []
  67. return None
  68. # ===== LLM 可调用的 goal 工具 =====
  69. @tool(description="管理执行计划,添加/完成/放弃目标,切换焦点", hidden_params=["context"])
  70. async def goal(
  71. add: Optional[str] = None,
  72. reason: Optional[str] = None,
  73. after: Optional[str] = None,
  74. under: Optional[str] = None,
  75. done: Optional[str] = None,
  76. abandon: Optional[str] = None,
  77. focus: Optional[str] = None,
  78. context: Optional[dict] = None
  79. ) -> str:
  80. """
  81. 管理执行计划,添加/完成/放弃目标,切换焦点。
  82. Args:
  83. add: 添加目标(逗号分隔多个)
  84. reason: 创建理由(逗号分隔多个,与 add 一一对应)
  85. after: 在指定目标后面添加(同层级)
  86. under: 为指定目标添加子目标
  87. done: 完成当前目标,值为 summary
  88. abandon: 放弃当前目标,值为原因
  89. focus: 切换焦点到指定 ID
  90. context: 工具执行上下文(包含 store、trace_id、goal_tree)
  91. Returns:
  92. str: 更新后的计划状态文本
  93. """
  94. # GoalTree 从 context 获取,每个 agent 实例独立,不再依赖全局变量
  95. tree = context.get("goal_tree") if context else None
  96. if tree is None:
  97. return "错误:GoalTree 未初始化"
  98. # 从 context 获取 store、trace_id 和 knowledge_config
  99. store = context.get("store") if context else None
  100. trace_id = context.get("trace_id") if context else None
  101. knowledge_config = context.get("knowledge_config") if context else None
  102. return await goal_tool(
  103. tree=tree,
  104. store=store,
  105. trace_id=trace_id,
  106. add=add,
  107. reason=reason,
  108. after=after,
  109. under=under,
  110. done=done,
  111. abandon=abandon,
  112. focus=focus,
  113. knowledge_config=knowledge_config
  114. )
  115. # ===== 核心逻辑函数 =====
  116. async def goal_tool(
  117. tree: "GoalTree",
  118. store: Optional["TraceStore"] = None,
  119. trace_id: Optional[str] = None,
  120. add: Optional[str] = None,
  121. reason: Optional[str] = None,
  122. after: Optional[str] = None,
  123. under: Optional[str] = None,
  124. done: Optional[str] = None,
  125. abandon: Optional[str] = None,
  126. focus: Optional[str] = None,
  127. knowledge_config: Optional[object] = None,
  128. ) -> str:
  129. """
  130. 管理执行计划。
  131. Args:
  132. tree: GoalTree 实例
  133. store: TraceStore 实例(用于推送事件)
  134. trace_id: 当前 Trace ID
  135. add: 添加目标(逗号分隔多个)
  136. reason: 创建理由(逗号分隔多个,与 add 一一对应)
  137. after: 在指定目标后面添加(同层级)
  138. under: 为指定目标添加子目标
  139. done: 完成当前目标,值为 summary
  140. abandon: 放弃当前目标,值为原因
  141. focus: 切换焦点到指定 ID
  142. knowledge_config: 知识管理配置(KnowledgeConfig 对象)
  143. Returns:
  144. 更新后的计划状态文本
  145. """
  146. changes = []
  147. # 1. 处理 done(完成当前目标)
  148. if done is not None:
  149. if not tree.current_id:
  150. return f"错误:没有当前目标可以完成。当前焦点为空,请先使用 focus 参数切换到要完成的目标。\n\n当前计划:\n{tree.to_prompt()}"
  151. # 完成当前目标
  152. # 如果同时指定了 focus,则不清空焦点(后面会切换到新目标)
  153. # 如果只有 done,则清空焦点
  154. clear_focus = (focus is None)
  155. goal = tree.complete(tree.current_id, done, clear_focus=clear_focus)
  156. display_id = tree._generate_display_id(goal)
  157. changes.append(f"已完成: {display_id}. {goal.description}")
  158. # 推送事件
  159. if store and trace_id:
  160. await store.update_goal(trace_id, goal.id, status="completed", summary=done)
  161. # 检查是否有级联完成的父目标(complete方法已经处理,这里只需要记录)
  162. if goal.parent_id:
  163. parent = tree.find(goal.parent_id)
  164. if parent and parent.status == "completed":
  165. parent_display_id = tree._generate_display_id(parent)
  166. changes.append(f"自动完成: {parent_display_id}. {parent.description}(所有子目标已完成)")
  167. # 2. 处理 focus(切换焦点到新目标)
  168. if focus is not None:
  169. goal = tree.find_by_display_id(focus)
  170. if not goal:
  171. return f"错误:找不到目标 {focus}\n\n当前计划:\n{tree.to_prompt()}"
  172. tree.focus(goal.id)
  173. display_id = tree._generate_display_id(goal)
  174. changes.append(f"切换焦点: {display_id}. {goal.description}")
  175. # 自动注入知识
  176. inject_msg = await inject_knowledge_for_goal(goal, tree, store, trace_id, knowledge_config)
  177. if inject_msg:
  178. changes.append(inject_msg)
  179. # 3. 处理 abandon(放弃当前目标)
  180. if abandon is not None:
  181. if not tree.current_id:
  182. return f"错误:没有当前目标可以放弃。当前焦点为空。\n\n当前计划:\n{tree.to_prompt()}"
  183. goal = tree.abandon(tree.current_id, abandon)
  184. display_id = tree._generate_display_id(goal)
  185. changes.append(f"已放弃: {display_id}. {goal.description}")
  186. # 推送事件
  187. if store and trace_id:
  188. await store.update_goal(trace_id, goal.id, status="abandoned", summary=abandon)
  189. # 4. 处理 add
  190. if add is not None:
  191. # 检查 after 和 under 互斥
  192. if after is not None and under is not None:
  193. return "错误:after 和 under 参数不能同时指定"
  194. descriptions = [d.strip() for d in add.split(",") if d.strip()]
  195. if descriptions:
  196. # 解析 reasons(与 descriptions 一一对应)
  197. reasons = None
  198. if reason:
  199. reasons = [r.strip() for r in reason.split(",")]
  200. # 如果 reasons 数量少于 descriptions,补空字符串
  201. while len(reasons) < len(descriptions):
  202. reasons.append("")
  203. # 确定添加位置
  204. if after is not None:
  205. # 在指定 goal 后面添加(同层级)
  206. target_goal = tree.find_by_display_id(after)
  207. if not target_goal:
  208. return f"错误:找不到目标 {after}\n\n当前计划:\n{tree.to_prompt()}"
  209. new_goals = tree.add_goals_after(target_goal.id, descriptions, reasons=reasons)
  210. changes.append(f"在 {tree._generate_display_id(target_goal)} 后面添加 {len(new_goals)} 个同级目标")
  211. elif under is not None:
  212. # 为指定 goal 添加子目标
  213. parent_goal = tree.find_by_display_id(under)
  214. if not parent_goal:
  215. return f"错误:找不到目标 {under}\n\n当前计划:\n{tree.to_prompt()}"
  216. new_goals = tree.add_goals(descriptions, reasons=reasons, parent_id=parent_goal.id)
  217. changes.append(f"在 {tree._generate_display_id(parent_goal)} 下添加 {len(new_goals)} 个子目标")
  218. else:
  219. # 默认行为:添加到当前焦点下(如果有焦点),否则添加到顶层
  220. parent_id = tree.current_id
  221. new_goals = tree.add_goals(descriptions, reasons=reasons, parent_id=parent_id)
  222. if parent_id:
  223. parent_display_id = tree._generate_display_id(tree.find(parent_id))
  224. changes.append(f"在 {parent_display_id} 下添加 {len(new_goals)} 个子目标")
  225. else:
  226. changes.append(f"添加 {len(new_goals)} 个顶层目标")
  227. # 推送事件
  228. if store and trace_id:
  229. for goal in new_goals:
  230. await store.add_goal(trace_id, goal)
  231. # 将完整内存树状态(含 current_id)同步到存储,
  232. # 因为 store.add_goal / update_goal 各自从磁盘加载,不包含 focus 等内存变更
  233. if store and trace_id and changes:
  234. await store.update_goal_tree(trace_id, tree)
  235. # 返回当前状态
  236. result = []
  237. if changes:
  238. result.append("## 更新")
  239. result.extend(f"- {c}" for c in changes)
  240. result.append("")
  241. result.append("## Current Plan")
  242. result.append(tree.to_prompt())
  243. return "\n".join(result)
  244. def create_goal_tool_schema() -> dict:
  245. """创建 goal 工具的 JSON Schema"""
  246. return {
  247. "name": "goal",
  248. "description": """管理执行计划。目标工具是灵活的支持系统,帮助你组织和追踪工作进度。
  249. 使用策略(按需选择):
  250. - 全局规划:先规划所有目标,再逐个执行
  251. - 渐进规划:走一步看一步,每次只创建下一个目标
  252. - 动态调整:行动中随时 abandon 不可行的目标,创建新目标
  253. 参数:
  254. - add: 添加目标(逗号分隔多个)
  255. - reason: 创建理由(逗号分隔,与 add 一一对应)
  256. - after: 在指定目标后面添加同级目标。使用目标 ID。
  257. - under: 为指定目标添加子目标。使用目标 ID。如已有子目标,追加到最后。
  258. - done: 完成当前目标,值为 summary(记录关键结论)
  259. - abandon: 放弃当前目标,值为原因
  260. - focus: 切换焦点到指定目标。使用目标 ID。
  261. 位置控制(优先使用 after):
  262. - 不指定 after/under: 添加到当前 focus 下作为子目标(无 focus 时添加到顶层)
  263. - after="X": 在目标 X 后面添加兄弟节点(同层级)
  264. - under="X": 为目标 X 添加子目标
  265. - after 和 under 不能同时指定
  266. 执行顺序:
  267. - done → focus → abandon → add
  268. - 如果同时指定 done 和 focus,会先完成当前目标,再切换焦点到新目标
  269. 示例:
  270. - goal(add="分析代码, 实现功能, 测试") - 添加顶层目标
  271. - goal(add="设计接口, 实现代码", under="2") - 为目标2添加子目标
  272. - goal(add="编写文档", after="3") - 在目标3后面添加同级任务
  273. - goal(add="集成测试", after="2.2") - 在目标2.2后面添加同级任务
  274. - goal(done="发现用户模型在 models/user.py") - 完成当前目标
  275. - goal(done="已完成调研", focus="2") - 完成当前目标,切换到目标2
  276. - goal(abandon="方案A需要Redis,环境没有") - 放弃当前目标
  277. 注意:
  278. - 目标 ID 的格式为 "1", "2", "2.1", "2.2" 等,在计划视图中可以看到
  279. - reason 应该与 add 的目标数量一致,如果数量不一致,缺少的 reason 将为空
  280. """,
  281. "parameters": {
  282. "type": "object",
  283. "properties": {
  284. "add": {
  285. "type": "string",
  286. "description": "添加目标(逗号分隔多个)"
  287. },
  288. "reason": {
  289. "type": "string",
  290. "description": "创建理由(逗号分隔多个,与 add 一一对应)。说明为什么要做这些目标。"
  291. },
  292. "after": {
  293. "type": "string",
  294. "description": "在指定目标后面添加(同层级)。使用目标的 ID,如 \"2\" 或 \"2.1\"。"
  295. },
  296. "under": {
  297. "type": "string",
  298. "description": "为指定目标添加子目标。使用目标的 ID,如 \"2\" 或 \"2.1\"。"
  299. },
  300. "done": {
  301. "type": "string",
  302. "description": "完成当前目标,值为 summary"
  303. },
  304. "abandon": {
  305. "type": "string",
  306. "description": "放弃当前目标,值为原因"
  307. },
  308. "focus": {
  309. "type": "string",
  310. "description": "切换焦点到指定目标。使用目标的 ID,如 \"2\" 或 \"2.1\"。"
  311. }
  312. },
  313. "required": []
  314. }
  315. }