jianf/homeagent-sdk
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-10-31 06:17:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
167 Commits 6 Branches 10 Tags
db58f66d83674863ca24d42396b70e180f9f33e8
Commit Graph

11 Commits

Author SHA1 Message Date
root
db58f66d83 docs(skills): 按需插件 skill 对齐仓内规范 + 文件操作强制走 files 插件 
## 1. 文件操作必须走 files 插件（用户明确要求）

旧 skill 写着「如果你已经有 run_shell / bash 之类的能力，优先用那个 —— 它更直接」，
与「文件操作必须走 files_*」相悖。改为：

- 所有已知内容的读写一律 files_read/files_write/files_edit/files_edit_line；
- 不用 cat/echo/sed/tee/重定向代替（shell 拼长文本会被引号转义吃掉，
  且重定向会截断原文件，而本插件是原子写 + 写前留档）；
- 唯一例外：文件是命令的副产物（go build -o、git clone、日志重定向）。

cmd-tools skill 同步补一条：文件读写不要用 shell 代替。

## 2. 三个新 skill 对齐 ai_image 等既有规范

- 结构统一为：什么时候用 / 先拉起插件（plugin_start 代码块）/ 工具表 /
  用完可释放（plugin_stop）/ 注意 / 「plugin_stop vs plugin_disable」对照表；
- 修正上一版的错误：把 `plugin_enable` 写成拉起方式 —— 那是**持久**解禁，
  会改开机行为；按需拉起应使用 `plugin_start name=<插件>`。
- files skill 保持 auto_start=false（与「大部分插件不需要自启」一致），
  但把「怎么拉起」写清楚。

## 3. cmd_run 描述补充能力边界

「经完整 bash 执行，支持管道、分号、&&、命令替换、heredoc、重定向；
不支持交互（vim/ssh/top 用 terminal_create）」。

验证：四工程 hmapdev 构建通过；本机重装后 skills_registered=1；
问 agent 写文件时它先 plugin_start 再 files_write/files_read，未用 shell 代替。
 2026-10-20 08:57:53 +08:00
root
e849f39663 feat(examples): 内置插件外置化 —— cmd/localuse/mcp 迁入 example + files 新增按行号精确编辑 
## 背景

主仓按「只有必须使用内部 SDK 能力的插件才内置」的判定标准（见主仓
ARCHITECTURE「内置插件的判定标准」）把纯公开 SDK 插件移出编译期内置清单。
本仓为它们提供外部插件工程（example/ 下，hmapdev 可直接构建）。

★ 终审翻案：kbtree 与 multimodal **不**在本次外置之列 —— 逐方法对照
公开 SDK 后发现它们依赖内部专有能力（kbtree 要 KnowledgeAPI 的
Subtree/CategoryCounts/SearchIn/Categories 与树视图类型；multimodal 要
LLMAPI.Chat 与多模态消息类型），公开面没有，已加回主仓内置清单。

## 新增工程（全部对齐当前模板 + 随用随起契约）

| 工程 | 工具 | auto_start | 说明 |
|---|---|---|---|
| cmd | cmd_run | false（按需） | 沙箱执行 shell 命令 |
| localuse | screensee/screensue/camerasue/speakeruse/clipboardsee/clipboardsue/computeruse | false（按需） | 本机外设 |
| mcp | mcp_add/list/remove/restart_server | false（按需） | MCP 服务器接入（stdio/SSE） |

每工程：plg.json（含 sdk 字段声明）+ skill/<name>-tools/SKILL.md +
README。按 auto_start 契约（sdk/autostart.go 的 OnDemandNeedsSkill），
**auto_start=false 必须配 skill**，否则工具不出现在初始清单 ⇒ 模型不知道
它存在 ⇒ 永远不会被拉起，等于没装还占地方。

## 移植要点

- 注册：内置版 init()+RegisterFactory → 外部版导出 NewPluginFactory；
  RegisterPluginMeta 的显示名进 plg.json/plugin.json。
- mcp：本地 rpcRequest/rpcResponse/rpcError 与 hmapdev 生成的
  z_proc_gen.go 同名冲突（构建期生成物与本目录源码同包编译），
  本地类型改名 mcpRPC*；internal/safeclose 内联为 safeCloseChan
  （外部插件不能引 internal 包，close-of-closed-channel 纪律随之带过来）。
- module 名：cmd 的 go.mod 用 homeagent-cmd（避免与标准库 cmd 混淆）；
  name_en 对齐插件名，hmapdev 以 toSnake(name_en) 命名产物
  （此前误写 Command/Local，产物成了 command_/local_）。

## files：新增 files_edit_line（按行号精确编辑）

files_edit 要求 old 文本全文件唯一，改「第三个 case 的 break」这类
非唯一文本时只能退化为整文件重写（有损）。files_edit_line 按行号
定位，op=replace/insert/delete，支持：
- 多条 edit 从后往前应用（前面行号不漂移）
- expect 安全闸：行内容与预期不符则整体拒绝（防行号过期改错位置）
- CRLF/末尾换行保真

skill 同步补 edit_line 行。测试 5 条（含 expect 拒绝路径）。

## 验证

hmapdev build 四工程全过：cmd/localuse/mcp/files 产物齐；
go test files 全绿。
 2026-10-19 22:01:07 +08:00
JianFeeeee
74e2c654ed feat(sdk): 22 个示例插件配齐 skill + 三态启动声明 + 打包期校验 
## 用户的三条要求

1. 「所有插件都默认自启会占启动时间，还在 llms 上下文塞大量工具」
   ⇒ 纯工具型改为按需加载，靠 skill 让 agent 知道要先拉起。
2. 「会向 agent 注入输入的部分插件不能这样做」
   ⇒ 9 个必须常驻，其余 13 个按需。
3. 「sdk 是不是没有暴露插件声明自身行为的方案」
   ⇒ 对：auto_start 只在 internal/plugin/manifest.go 有，SDK 零命中。

## 定级依据（代码证据，不是猜描述）

注入 / 钩子 ⇒ 必须常驻（9 个）：

	qq         HTTP 监听 NapCat 推送，消息到达要立刻注入
	rss        轮询订阅源，新文章主动推送
	calendar   30s ticker 检查提醒
	memo       5min ticker 检查待办到期
	a2a        TCP 监听外部 Agent 请求
	acp        TCP 监听 ACP 客户端
	browser    ticker + 长命令完成回调
	sanitizer  注册 stage 钩子（无工具，要每轮生效）
	luademo    注册 stage 钩子做示范

纯工具型 ⇒ 按需（13 个）：
	weather ocr music bili ai_image files editdoc deepsearch
	plugindev recoverydiag vanblog vikunja commondev

★ commondev 值得单独说：它虽然有 6 处 Inject 调用，但**注入源是自己的
sidecar 完成回投**，而 sidecar 只在 commondev_agent_up 时才拉起
（Start() 里不启 sidecar，通道也在 agent_up 时才注册）。所以没有 agent
调用它时，它不需要做任何事 —— 可以按需。44 个工具 ≈726 tokens 省下来可观。

## 改动

 · 22 个插件各配一个 skill，写明：何时用、先 plugin_start、
   工具清单、**用 plugin_stop 而不是 plugin_disable**
 · 13 个 plg.json 加 `auto_start: false`
 · `sdk/autostart.go`：把三态语义与"按需插件必须有 skill"的理由写进公开 SDK
 · hmapdev 打包期校验：`auto_start=false` 但无 skill/ 目录 ⇒ 直接 exit 1
   （理由：缺 skill 的按需插件**等价于没装**，比没装更糟 —— 占着磁盘让人以为可用）
 · 修 Lua 打包路径：它**完全不走** rawfile/skill 收集，luademo 的 skill 永远打不进去
 · 修 build-examples.sh：原来 `[ ! -x ]` 判"二进制在不在"，改了 hmapdev 源码后
   重新打包**仍用旧工具链**（实测：luademo 的 skill 一直是 0）
 · 补 mocksdk.ToolDef.Timeout（上一轮加 ToolDef.Timeout 时漏了镜像）

## 判据

 · TestHasSkillDirRequiresRealSkillMd（空目录/.gitkeep/无 SKILL.md 都不算）
 · TestBuildRejectsOnDemandWithoutSkill（打包期必须真拦住 + exit 1）
 · TestLuaPackagingCollectsSkillAndRawfiles（**验代码行**，不验注释 —— 第一版
   只查符号存在，把 createHmapWithRaw 换回 createHmap 判据照样通过）

## 踩过的坑

 · Lua 分支的结束边界原是 `// Resolve build config`，但那个注释在文件里
   **出现多次**（Go 路径里也有），用它截取会把 Go 分支一起包进来 ⇒
   变异测不出。改成截到 Lua 分支自己的 `return` + `}`。
 2026-10-18 13:21:47 +08:00
JianFeeeee
b6a6168e65 chore(module)!: module 路径随托管地迁移 gitcode → github 
SDK 仓已迁到 GitHub 作为权威源，go module 路径同步：
`gitcode.com/JianFeeeee/homeagent-sdk` → `github.com/JianFeeeee/homeagentsdk`

## 范围

74 个文件：71 个 Go 源码 + go.mod/go.sum + hmapdev 模板 + CI 与打包脚本。

主仓（HomeAgent）侧对应改动是 6d38a164。本仓这些文件当时**不在工作树上**
（见下），所以那次的批量替换扫不到它们——这里是补偿。

## 为何这批文件当时不在工作树上（事故与恢复）

10-08 07:58 主仓做 checkout/cherry-pick 序列时，把本仓工作树的 20 个文件
误清理了（`example/*/plugin.go` + `plg.json`，10 个示例）。

根因是**结构误判**：本仓是「一目录两仓库」结构下主仓 `third_party/` 里的
**独立 git 仓库**，而主仓 .gitignore 忽略了 `example/`，于是它在主仓
`git status` 里不可见 —— 看着像「不受跟踪的构建产物」，实际是本仓受跟踪的源码。

已全部恢复（`git checkout -- <D 文件>`，只恢复删除、不动迁移改动），
20 个文件与 HEAD 逐字节一致。

**破坏的连锁后果**：恢复出来的 `plugin.go` 仍写着旧 module 路径，
因为迁移时它们已不在工作树上。所以这次补偿是必须的，不是可选优化。

## 保留 gitcode 引用

以下位置的 `gitcode` **有意保留**，不要"顺手清掉"：
- README.md / docs 里「二进制实际分发地址目前是 gitcode」的说明
- mkdocs.yml 的 gitcode 镜像链接（国内直连更快）
- `tools/hmapdev/templates.go` 里「SDK 已从 gitcode 迁到 GitHub」的注释

gitcode 仍是**只读镜像**（源码同步；release 附件暂时仍在那边）。

## 验证

- 本仓根 module：`go build ./...` + `go test ./...` 全通过
- 全部 20 个 example：`go vet` 通过（补偿前 10 个因旧 module 路径失败）
- example/qq：`go test` 通过，且能从源码 build 出可用 plugin 产物
 2026-10-09 07:25:25 +08:00
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
JianFeeeee
cca9fdce9c example: 新增 acp(ACP 代理通信)、vanblog(VanBlog 博客管理) 插件; 多插件工具调用检测与清理改进; weather 移除 onRemove/文本记忆; plugindev 精简 2026-08-15 09:03:05 +08:00
root
2b54814037 examples: update weather with v0.8.0 API surface, add luademo Lua example, fix go.mod replaces 2026-07-31 10:59:13 +08:00
JianFeeeee
04837f237d plugindev: 全面 plg.json 持久化 + --replace 支持 + 文档 2026-07-25 15:47:49 +08:00
JianFeeeee
cb7999ca71 feat: sdk NoMemory/Cleaner + example build fixes 
- sdk/plugin.go: ToolDef adds NoMemory/Cleaner fields
- sdk/plugin_test.go: unit tests for NoMemory/Cleaner
- all example plugins: NoMemory/Cleaner annotated for each tool
- plugindev/templates.go: template shows NoMemory/Cleaner pattern
- plugindev/cmd_build.go: fix ensureGoMod, buildBundle/buildTarget sdkPath param, NewPluginFactory
- example/go.mod: add external dependency declarations (chromedp, gofeed)
- add main.go stubs for all example plugins
 2026-07-25 11:17:21 +08:00
root
1a3e72e899 fix: use short config keys in RegisterDef, remove generics helpers 
- qq, a2a, bili, files, rss: RegisterDef keys changed from
  namespaced (e.g. "plugin.qq.listen") to short flat keys ("listen")
- a2a, bili: Get() calls updated to match short keys
- rss: replaced readCfg generics with getSetting, added SetAutoRestart(true)
- files: already uses short key Get, only RegisterDef needed fixing
 2026-07-21 13:20:13 +08:00
root
1762f0c34b docs: 修正全部文档使其与源码实现一致 
- Plugin.Start(sdk *PluginSDK) 接口签名改为指针
- 方法表重写: 移除 CallLLM/QueryKnowledge/SetMemory 等不存在方法
- IOInjector 参数顺序修正为 (source, channel, text)
- 删除虚构 SDKConfig, 替换为实际 New() 构造函数签名
- .hmap 内容描述一致化 (plugin.so + plugin.dll + main.lua)
- 添加 meta/ 包元数据文件
 2026-07-18 20:47:17 +08:00