mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-22 01:48:03 +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）**未纳入本次提交**。
49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
# sanitizer · 文本清洗
|
||
|
||
**不注册任何工具**，只挂三个阶段钩子，在 Agent 全链路上洗掉两类污染：
|
||
|
||
1. **坏字节**：坏 UTF-8、`U+FFFD`（替换符）、ANSI 转义序列
|
||
2. **思维泄漏**：LLM 输出里残留的工具调用标记
|
||
|
||
## 为什么需要它
|
||
|
||
坏字节会**被 LLM 复读**。一次工具返回乱码（比如源码里带 ANSI 颜色码、或二进制片段被当文本读出来），
|
||
这些字节会进上下文，之后模型每次生成都可能把它抄一遍 —— 越滚越脏。
|
||
在每个入口洗掉，比事后清理便宜得多。
|
||
|
||
思维泄漏则是另一种：模型有时把 `<tool_call>...</tool_call>` 这类内部标记直接写进正文，
|
||
用户就看到一堆不该出现的 XML。
|
||
|
||
## 挂载的三个阶段
|
||
|
||
| 阶段 | 处理对象 | 作用 |
|
||
|---|---|---|
|
||
| `on_input` | `ctx.RawMessage` | 洗用户输入，脏字节不进后续链路 |
|
||
| `after_toolcall` | `ctx.ToolResults` | 洗工具结果，**坏字节不进 LLM 上下文** |
|
||
| `post_action` | `ctx.LLMText` | 洗模型输出：先清思维泄漏，再清乱码 |
|
||
|
||
每次有改动都打一行日志（`cleaned N bytes`），便于确认它真的在工作而不是静默失败。
|
||
|
||
## 识别哪些泄漏形态
|
||
|
||
按正则匹配多种标记写法，覆盖不同模型家族的习惯：
|
||
|
||
- `<tool_call>…</tool_call>`、`<invoke>…</invoke>`、`<tool>…</tool>`
|
||
- `<function>…</function>`
|
||
- 上述标记包在 ```xml / ```json 代码块里的形态
|
||
- 中文括号变体：`【tool_call】…【/tool_call】`
|
||
|
||
## 实现要点
|
||
|
||
- 依赖 **ABI v2 的 stage 写回能力**：插件对 `StageContext` 的修改会同步回内核。
|
||
在 v1 上改了不生效。
|
||
- 读写 `StageContext` 时按约定加 `ctx.Lock()`。
|
||
|
||
## 构建
|
||
|
||
```bash
|
||
go build -buildmode=plugin -o sanitizer.so .
|
||
```
|
||
|
||
或经 `hmapdev build` 打包为 `.hmap`。
|