jianf/homeagent-sdk
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-20 17:08:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7ef9bc2ad3736a74d7ad840c2e041623d0ef39dd
homeagent-sdk/example/browser/README.md
JianFeeeee 7ef9bc2ad3 docs(example): 为每个插件补 README 
此前 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）**未纳入本次提交**。
2026-09-20 00:43:06 +08:00

2.5 KiB
Raw Blame History

browser · 统一浏览器

一个插件覆盖三种"访问网页"的能力，从最轻到最重。按需选层是这个插件的重点 —— 绝大多数抓取用 HTTP 就够，不该为了一句话启动 Chromium。

三种能力层

层 工具 何时用
搜索 browser_search 要的是"找到哪些页面"，不是页面本身
quick（纯 HTTP） browser_fetch（mode=quick） 静态页、API、能直接拿到 HTML
normal（无头渲染） browser_render / browser_fetch（mode=render） JS 渲染的页面，HTTP 拿不到内容
interactive（CDP） browser_start + navigate/click/type/scroll/html/screenshot 需要交互：登录、点按、翻页

browser_fetch 的 mode：

  • auto（默认）：先试 HTTP，遇 403/429 才降级用 Chromium 渲染
  • render：强制 Chromium
  • quick：纯 HTTP，不降级

工具

工具 说明
browser_search 网页搜索
browser_fetch 抓取 URL 内容，三种 mode 见上
browser_render 无头 Chromium 渲染并提取文本（normal）
browser_start 启动交互式浏览器会话（CDP）
browser_navigate 导航到指定 URL
browser_click 点击元素
browser_type 输入文本
browser_scroll 滚动页面
browser_html 取当前页 HTML
browser_screenshot 截图
browser_install 安装 systemd 托管的共享浏览器后端
browser_close 关闭会话

共享浏览器后端

browser_install 安装 homeagent-browser.service（systemd 托管）。 装上之后所有 agent 共享同一个 Chromium 实例与登录态，各自占独立标签页互不干扰 （同 source 复用自己的标签页）。

前提：本机已有 chromium 二进制，没有会提示先装（apt install chromium 或等价）。

实现要点

  • 搜索用 cn.bing.com 而不是 www.bing.com：后者对程序化请求常回 302（同意/重定向页）， 根本拿不到结果块。
  • 标题取 <h2> 里的 <a>：直接抓结果块里第一个 <a> 会拿到来源行而非标题。
  • 摘要认 b_lineclamp：旧版 Bing 用 b_caption，新版已迁走，两套都匹配。
  • 有 SSRF 防护：见源码 SSRF 段，抓取前校验目标地址，避免被诱导访问内网。

测试

go test -count=1 ./...

testdata/bing_cn.html 是搜索解析的固定样本，用它做离线断言，避免测试依赖真实网络。

构建

hmapdev build