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）**未纳入本次提交**。
vanblog · VanBlog 博客管理
用管理 API 操作 VanBlog 开源博客系统： 文章增删改查、分类标签、草稿发布、备份导出等。
配置项
| 键 | 默认 | 说明 |
|---|---|---|
url |
https://blog.jianfgit.xyz |
VanBlog 站点基地址 |
token |
空 | 管理员 API Token（长期令牌，从后台「Token 管理」创建） |
reset_token |
空 | 用于 auth/restore 重置管理员密码的特殊 Token |
token 与 reset_token 都是 password 类型（界面遮蔽）。
工具（28 个）
文章
| 工具 | 说明 |
|---|---|
vanblog_list_articles |
列文章，支持分页与搜索 |
vanblog_get_article |
取单篇完整内容 |
vanblog_create_article |
新建（title 与 category 必填） |
vanblog_update_article |
更新（只传要改的字段） |
vanblog_delete_article |
删除（软删除） |
vanblog_search_articles |
按链接搜索文章 |
草稿
vanblog_manage_drafts：list / get / create / update / delete / publish
内容组织
| 工具 | 命令 |
|---|---|
vanblog_manage_categories |
list / get / create / update / delete |
vanblog_manage_tags |
list / get / rename / delete |
站点与运维
| 工具 | 说明 |
|---|---|
vanblog_manage_site / _settings / _menu / _social / _links |
站点配置类 |
vanblog_manage_about / _pages |
关于页与自定义页面 |
vanblog_manage_images |
图床管理 |
vanblog_manage_rewards |
赞赏配置 |
vanblog_manage_backup |
备份 |
vanblog_manage_caddy |
Caddy 配置 |
vanblog_manage_isr |
ISR 增量静态渲染 |
vanblog_manage_pipelines |
流水线 |
vanblog_manage_collaborators |
协作者 |
vanblog_manage_tokens |
Token 管理 |
vanblog_get_analysis / _logs / _meta |
统计、日志、元信息 |
vanblog_auth |
认证相关（含 restore 重置密码） |
工具名前缀取自插件名（
tp），上面按默认vanblog_列出。
实现要点
- 走的是 VanBlog 的管理 API（
/api/admin/...），所以必须配 admin token， 不是前台只读接口。 update_article是部分更新：只传想改的字段，没传的保持不变。 （不要为了改标题而把正文一起传一遍。）delete_article是软删除，内容仍在，可在后台恢复。- 早期版本把 token 放在内核配置（
plugin.vanblog.token）里， 现在会自动迁移到插件配置，迁移后清空内核侧取值。
前置
需要一个可访问的 VanBlog 实例，并在后台创建一个长期 Token。
构建
hmapdev build