AGENTS.md · git:20260912.a5523cc · 2026-09-12 · sha256 8796e5b4c4ed5af6
AGENTS.md git:20260912.a5523ccA
Immutable. This exact content never changes and is served at /api/v1/blob/8796e5b4c4ed5af6.
<!-- CodeWiki LLM Wiki -->
## CodeWiki LLM Wiki
本项目已使用 [CodeWiki](https://github.com/mambo-wang/CodeWiki-Plus) 生成 LLM Wiki 文档,位于 `repowiki/` 目录。
**入口文件:**
- [`repowiki/wiki/overview.md`](repowiki/wiki/overview.md) — 仓库级架构总览(含 Mermaid 架构图)
- [`repowiki/wiki/index.md`](repowiki/wiki/index.md) — 文档目录与知识笔记索引
- [`repowiki/schema.yaml`](repowiki/schema.yaml) — 项目文档约定(命名规范、必填章节等)
### 使用建议
1. **编码前**:先用 `query_wiki` 搜索相关模块文档,了解架构约定和依赖关系
2. **做决策时**:用 `query_wiki` 搜索已有的 `decision` 类型笔记,避免重复讨论
3. **完成重要决策后**:用 `ingest_note` 归档,让未来的 Agent 和团队成员都能查到
4. **定期维护**:用 `lint_wiki` 检查文档是否过时,保持文档与代码同步
5. **检索无结果时**:明确回复「未检索到相关文档」,不猜测、不用模糊记忆补位——空结果本身就是有信息量的答案
### 回答时显式标注依据
回答涉及本仓库的知识或代码时,在**关键论断处直接标注来源**,不要只写"根据文档/代码"却不给名字:
- 引用 `query_wiki` 检索到的文档/笔记 → 标注 `(依据:<file>)`,`<file>` 必须与检索结果返回的 `file` 字段完全一致(如 `notes/xxx.md`、`wiki/modules/yyy.md`);
- 引用代码事实(函数/类/配置/行为断言) → 标注 `<代码文件>:<行号>`(如 `codewiki/mcp/tools/adoption.py:32`)。行号以你实际读取代码/检索结果所见为准,**不要照抄文档里可能已过时的行号**;
- 依据来自本次代码核对而非文档 → 明说来源,如 `依据本次代码核对:<代码文件>:<行号>`。
正文标注是给人读的溯源承诺;行尾的 `codewiki:referenced-docs` 注释仍是机器采纳信号,两者并存、互不影响。
### 采纳声明(检索反馈)
当你通过 `query_wiki` 检索并**实际使用了**某条结果(作为决策依据、修改参照或答案来源)时,在最终回复中附带一行声明注释:
```
<!-- codewiki:referenced-docs: ["notes/pitfall-xxx.md", "wiki/modules/yyy.md"] -->
```
路径必须与 query_wiki 返回的 `file` 字段完全一致。声明过的文档会获得采纳计数(`usage.adopted_count`),在未来检索中排序提升(采纳权重是单纯召回的 2 倍);长期高频召回却零采纳的笔记会被 `lint_wiki` 的 `low_adoption` 检查标记为"需要重写得更可操作"。
**注意**:只声明真正用到的文档——这是帮助知识库学习"什么内容真正有用"的信号,不是礼貌性致谢。忘了声明没关系(漏报可容忍),但不要声明没用过的(误报不可容忍)。
### 纠正识别与经验沉淀
当你被用户纠正、吐槽或补充了未知上下文时,这可能是值得沉淀的经验。按以下规则处理:
**识别纠正信号(满足任一即触发):**
- 用户明确否定你的输出:"不对""你搞错了""不是这样的""应该是…"
- 用户表达重复犯错的不满:"又…""上次就…""为什么又…"
- 你修改了自己的输出后用户仍不满意,说明理解有根本偏差
- 用户补充了你不知道的关键上下文:"你不知道吗…""这个项目一直都是…""我们约定过…"
- 用户指出方法名/Javadoc 与实际行为不一致,或指出代码中的历史遗留问题
**执行三步流程:**
1. **反思**:明确说出自己错在哪里、正确做法是什么、根因是什么(是缺少项目上下文?还是对代码理解有误?)
2. **起草笔记**:将教训整理为结构化内容,包含:背景(什么场景下犯了错)、正确做法、根因分析
3. **征求确认**:向用户展示笔记草稿,询问"要把这条经验记录到 Wiki 吗?"——**必须得到用户确认后才执行 `ingest_note`**,不要默默保存
**归档示例:**
```json
{
"note_type": "lesson",
"title": "OrderService.process() 只做参数校验不做业务处理",
"content": "## 背景\n\nAgent 误以为 OrderService.process() 包含完整业务逻辑,基于方法名做了错误的设计假设。\n\n## 正确做法\n\nprocess() 仅做入参校验和格式化,实际业务处理在 OrderService.execute() 中。老项目方法名与实际行为不一致是常见情况,应优先阅读实现而非信任方法名。\n\n## 根因\n\n十几年老项目,方法经过多次重构但名称未更新。",
"related_modules": ["order"]
}
```
**注意**:不是每次纠正都需要沉淀。只记录有复用价值的经验——特定于本次任务的临时调整、用户个人偏好等不需要记录。判断标准:如果未来的 Agent 或新同事遇到同样场景时这条经验有用,就值得记录。
### 主动知识沉淀
不要等用户纠正才记录。当对话中出现以下信号时,主动执行反思并提取知识:
**触发信号(满足任一即激活反思):**
- 完成一个多步骤调试/排查后定位到根因(尤其是走了弯路的情况)
- 讨论了两个及以上方案并做出了选择
- 发现代码实际行为与文档/命名/注释不一致
- 用户补充了隐性项目知识(约定、历史原因、"我们一直这么做")
- 一次探索性调研收敛到明确结论
- 发现了可复用的模式、工具链用法或环境配置技巧
**四问过滤(全部通过才值得记录):**
1. 下一次对话(无本次上下文)还能用到吗?
2. 另一个 Agent 或新同事遇到同样场景能直接受益吗?
3. `query_wiki` 确认现有文档未覆盖?
4. 属于"事实/决策/模式/教训"而非"本次任务临时状态"?
**路由表:**
| 知识类型 | 写入方式 |
|---------|---------|
| 做了技术选型/方案取舍 | `ingest_note(note_type="decision")` |
| 踩坑/易错点 | `ingest_note(note_type="pitfall")` |
| 经验教训(调试过程、认知修正) | `ingest_note(note_type="lesson")` |
| 架构层面的事实发现 | `ingest_note(note_type="architecture")` |
| 临时绕过方案(含恢复条件) | `ingest_note(note_type="workaround")` |
| 多方案横向对比(含表格) | `write_doc_file(page_type="comparison")` |
| 调研结论存档 | `write_doc_file(page_type="query")` |
**执行流程:**
1. 识别到触发信号后,回顾相关对话片段,提取候选知识项
2. 对每个候选项执行四问过滤,丢弃未通过的
3. 用 `query_wiki` 检查是否已有覆盖(避免重复)
4. 按路由表确定写入方式,起草结构化内容(背景→结论→根因→适用范围)
5. 向用户展示草稿并征求确认——**必须确认后才写入**
6. 一次对话中可积累多个候选项,在自然停顿点(任务完成、话题切换)统一呈现,避免频繁打断
**不要记录的内容:**
- 仅与本次任务相关的临时变量、路径、参数
- 用户个人偏好(这属于 Agent 记忆,不属于项目 Wiki)
- 已在代码注释或 README 中明确写明的信息
- 未经验证的猜测或"可能""也许"级别的推断
<!-- /CodeWiki LLM Wiki -->
## Agent skills
### Issue tracker
Issues live in this repo's GitHub Issues (uses the `gh` CLI). See `docs/agents/issue-tracker.md`.
### Triage labels
Five canonical roles: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. See `docs/agents/triage-labels.md`.
### Domain docs
Single-context layout: root `CONTEXT.md` + `docs/adr/`. See `docs/agents/domain.md`.
## Team memory fusion (conversation → Wiki)
借鉴 Team-Agent-Memory 的"从对话中提取可检索经验"能力,融合进 CodeWiki 知识飞轮。
**实现入口:**
- `codewiki/mcp/tools/knowledge_loop.py` — `capture_conversation` 工具(采集对话到 `repowiki/raw/`)
- `codewiki/mcp/tools/distill_conversation.py` — `distill_conversation` 工具(蒸馏 raw → 结构化知识)
- `codewiki/mcp/_ide_hook.py` — IDE hook 采集脚本(默认关,`--enable` 或环境变量开启)
- `repowiki/team-memory-hook.md` — Hook 接线文档与配置说明
- `repowiki/ontology.yaml` — 本体论术语表模板(可选,增强检索)
- MCP prompt `team-memory-hook`(prompts/list)— 启用/关闭采集 hook 的操作指引
- MCP prompt `distill-conversations`(prompts/list)— 蒸馏工作流指引(prepare → 提取 → submit → 评审)
**关键设计约束(实现时务必遵守):**
- `distill_conversation` 是**无状态**工具,自身不持有 LLM;LLM 由调用方提供。三种模式:**Mode A**(subagent 注入 `llm` async 回调,内联)、**Mode B**(`run_in_background=true`,从 `MAIN_MODEL`/`LLM_BASE_URL` 环境变量构建)、**Mode C**(IDE Agent 自己当 LLM:`mode="prepare"` 取 transcript+system prompt → Agent 提取 → `mode="submit"` 交回 `distilled` JSON,纯 MCP JSON 可走)。蒸馏是 LLM 重活,必须异步/后台执行,不阻塞主线程。
- 自动采集 IDE hook(可选,默认关)**只落 raw,不蒸馏**;蒸馏需显式调用 `distill_conversation`,永不自动发生。
- `repowiki/raw/` 是**暂存区,不进 `query_wiki` 检索**,蒸馏完成后由 `distill_conversation` 删除(除非 `keep_raw`);未蒸馏的 raw 会一直保留(无自动过期);不膨胀、不影响查询性能。
- 蒸馏产出 `status=draft` 的 note,须 `confirm_note` 确认后才成正式知识。
- 触发形态:**both** —— 手动命令(主) + IDE hook(可选)。
- **Mode C submit 走 `distilled_file` 文件侧通道(勿内联大 JSON)**:多条大对话蒸馏时,`distilled` 内联参数可能超出 MCP 传输限制导致失败。正确做法:先用 `write_to_file` 把蒸馏 JSON(形状 `{conversation_id: {notes, memories}}`,或单条裸 `{notes, memories}` 配合 `conversation_id` 参数)写入 `repowiki/raw/.distill-*.json`,再 `distill_conversation(mode="submit", distilled_file=<路径>)` 只传小路径;相对路径先按推导出的 repowiki 目录再按 CWD 解析。小载荷仍可内联 `distilled`(两者可合并,内联优先)。**不要再写临时 Python 脚本调用 handler 绕过**。
<!-- TEAM-MEMORY-TASK:START -->
## Task memory (任务记忆)
跨会话延续长线工作上下文。任务记忆是**任务范围内的进度知识**(本次做了什么、下一步、待办),与 Wiki 笔记(**跨任务的通用经验**)互补。
**会话开始时(必须执行):**
1. `list_tasks(status="active")` 列出进行中的任务
2. **必须用 `ask_followup_question` 弹框,且只弹一次、一框列全**:只调用 1 次,questions 数组只放 1 个 question(标题「任务关联」,multiSelect=false),options 一次性列出「每个进行中任务」+「新建任务…(在输入框直接输入名称)」+「跳过」。**严禁**因工具 schema 建议 2-4 个 options 就拆成多个 question 或分多次弹框;唯一例外是用户选了「新建任务…」却没给名字,可再弹一次要名字
3. 用 `set_session_task(source_session_id=<会话id>, task_id=<任务id>)` 绑定;列表里没有的任务名先 `create_task(title=<任务名>)` 再绑定;用户选「跳过」则本次不关联
4. `get_task_context(task_id=<选中任务>)` 拉取任务描述 + 记忆 + 关联笔记
5. `pending_raw_count > 0` 时**委托 subagent 后台补蒸馏,不阻塞回答**:蒸馏产出的草稿笔记须 `confirm_note` 确认后才落盘;任务记忆直写、无需确认(ADR-0002)
完整工作流、存储布局与实现约束见 MCP prompt:`get_prompt(name="task-workflow")` —— 按需获取,不在此重复。
<!-- TEAM-MEMORY-TASK:END -->