mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-20 17:08:01 +00:00
7ef9bc2ad3
此前 example/ 下 21 个插件里，13 个完全没有 README，另 4 个是 `hmapdev init` 生成的脚手架样板（`# <name>` + `plugin build` + `Install` 三行， 等于从没被写过）。只有 deepsearch / vikunja / plugindev / luademo 是真实文档。 本次为 **17 个**插件写了真文档（13 个缺失 + 4 个样板），现在 21 个全部有内容。 ## 写法 每个 README 覆盖：能力一句话 → 为什么需要 → 工具表 → 配置项表 → 通道与钩子（有才写）→ 构建 → 已知边界。 **事实全部从源码读出来，不推测**： - 工具名核对到注册点（含 `tp+"x"` / `p.name+"_x"` 前缀拼接，展开成最终名） - 配置键与默认值取自 `RegisterDef` / getStr 默认值 - 通道名、钩子名、依赖命令逐条 grep 确认 - 版本号与已部署实例交叉核对，17 个里 16 个一致 ## 几处按源码写、与直觉不同的点 - **rss**：订阅时会把抓到的历史条目一次性标为 seen，所以订阅一个源 **不会**把历史文章全推一遍 —— 这是避免刷屏的关键，写进了文档。 - **files**：路径校验是**两道**（规范化后判断 + 解析符号链接后再判断）， 只做前者的话沙箱里的软链接就能逃逸。两种情况报错文案不同。 - **qq**：身份必须**绑帧**而非存插件全局，源码注释记录了由此产生的两个真实故障 （中断抢占恢复后权限门整体失效、运行中到达的消息改写正在跑那一轮的身份）。 多来源合并时权限取**交集**。硬私有工具按前缀一律拒绝。这些是安全关键， 单独成节写清楚。 - **memo**：待办与备忘录**刻意分两类**（一提醒一不提醒），提醒注入带 NoMemory。 - **sanitizer**：不注册任何工具，只挂三个阶段钩子；依赖 ABI v2 的 stage 写回能力。 - **editdoc**：本目录是 v1.0.0（单工具），而线上跑 v2.0.0（全能版，源码未公开）—— 在文档开头显式标注，**不按 v2 描述**，避免读者以为这里就是线上那份。 ## 验证 - 21/21 文件非空且非样板（最小 913B，最大 6845B） - 逐个核对 README 中出现的工具名能在源码找到依据；5 处报警经复核**全是误报** （`ai_image_generate`/`music_*` 前缀来自 metadata 的 name，`on_input` 等是钩子不是工具） - README 版本号 vs 线上 plugin.json：16/17 一致，editdoc 的差异已显式说明 注：本仓既有未提交改动（example/qq/plugin.go、sdk/plugin.go）**未纳入本次提交**。
recoverydiag · 快速检查 / 崩溃取证
给 guard 与 failback 用的确定性诊断工具集。
设计基调（源码原话）：返回结论而非原文，确定性检出，不消耗 LLM token。 崩溃后最忌讳的是把几万行日志塞进模型上下文让它"看看"，那既慢又不可靠 —— 这里每个工具都在本地算出结论再返回。
工具
| 工具 | 说明 |
|---|---|
recoverydiag_diag_triage |
快速分诊：按退出码 / 信号 / 存活状态粗分类别（进程死亡 vs 配置类不可达 vs 正常） |
recoverydiag_diag_db |
config.db 完整性（PRAGMA integrity_check）+ LLM 源解析校验（core.llm.sources.* 必备字段），逐项 ok/fail |
recoverydiag_diag_log_scan |
在日志目录的时间窗内统计已知错误签名（panic / OOM / 网络不可达 / provider 失败 / sql / 致命）出现次数，给出主导结论 |
recoverydiag_diag_delta |
对比 baseline（上次 good 快照/目录）与现状，列出 created / modified / deleted 清单与摘要，判定"改了什么" |
recoverydiag_diag_loc |
综合前四项结论，按因果强度正交排序定位根因并给出推荐恢复动作 |
用法顺序
diag_triage → diag_db → diag_log_scan → diag_delta → diag_loc
（各自独立，可只跑需要的） （要传前四项的结论）
diag_loc 需要你把它余下的结论作为参数传进去（triage / db / log / delta 四个对象），
它不自己去调 —— 这样它只做归因，不重复执行。
配置项
| 键 | 默认 | 说明 |
|---|---|---|
db_check_cmd |
auto |
diag_db 用的 sqlite3 命令。留空=auto：可用时用 sqlite3，缺失则回退读内核 Settings |
recovery_kb_dir |
空 | diag_loc 结论 JSON 的落盘目录。缺省 <data_dir>/recovery_kb |
不注册通道与钩子
本插件只提供工具，不订阅输入、不挂阶段钩子 —— 它是被 guard 或 agent 主动调用的， 不做后台干预。
测试
go test -count=1 ./...
diag_test.go 覆盖各诊断项的判定逻辑。
构建
hmapdev build