mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 22:37:25 +00:00
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` + `}`。
This commit is contained in:
JianFeeeee
102
tools/hmapdev/autostart_skill_guard_test.go
Normal file
102
tools/hmapdev/autostart_skill_guard_test.go
Normal file
@ -0,0 +1,102 @@
|
||||
package main
|
||||
|
||||
// 打包期校验：`auto_start=false` 的插件**必须**带 skill。
|
||||
//
|
||||
// ## 为什么这条是必须的，而不是"建议"
|
||||
//
|
||||
// 逻辑链是闭合的：
|
||||
//
|
||||
// auto_start=false ⇒ 内核启动时不拉起 ⇒ 工具不在初始清单里
|
||||
// ⇒ 模型不知道它存在 ⇒ 永远不会被调用、也永远不会被拉起
|
||||
//
|
||||
// 也就是说：缺 skill 的按需插件**等价于没装**，但比没装更糟 ——
|
||||
// 它占着磁盘和安装记录，让人以为它可用（静默降级）。
|
||||
//
|
||||
// 所以校验放在**打包期**：比用户装完再困惑早得多。
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// ★★★ 判据：有真实 SKILL.md 才算"带 skill"。
|
||||
func TestHasSkillDirRequiresRealSkillMd(t *testing.T) {
|
||||
// ① 完全没有 skill/ 目录
|
||||
root1 := t.TempDir()
|
||||
if hasSkillDir(root1) {
|
||||
t.Fatal("★ 没有 skill/ 目录却判定为有 skill")
|
||||
}
|
||||
|
||||
// ② 有空 skill/ 目录
|
||||
root2 := t.TempDir()
|
||||
if err := os.MkdirAll(filepath.Join(root2, "skill"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if hasSkillDir(root2) {
|
||||
t.Fatal("★ 空 skill/ 目录被判为有 skill —— 校验形同虚设")
|
||||
}
|
||||
|
||||
// ③ 只有 .gitkeep 的脚手架目录
|
||||
root3 := t.TempDir()
|
||||
sk3 := filepath.Join(root3, "skill")
|
||||
if err := os.MkdirAll(sk3, 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(sk3, ".gitkeep"), nil, 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if hasSkillDir(root3) {
|
||||
t.Fatal("★ 只有 .gitkeep 的脚手架目录被判为有 skill")
|
||||
}
|
||||
|
||||
// ④ 有目录但没有 SKILL.md（空壳）
|
||||
root4 := t.TempDir()
|
||||
if err := os.MkdirAll(filepath.Join(root4, "skill", "myskill"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(root4, "skill", "myskill", "README.md"), []byte("x"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if hasSkillDir(root4) {
|
||||
t.Fatal("★ 只有目录没有 SKILL.md 却被判为有 skill —— 注册到 skillmgr 也是空壳")
|
||||
}
|
||||
|
||||
// ⑤ 真有一个 skill
|
||||
root5 := t.TempDir()
|
||||
if err := os.MkdirAll(filepath.Join(root5, "skill", "myskill"), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(root5, "skill", "myskill", "SKILL.md"), []byte("# x"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !hasSkillDir(root5) {
|
||||
t.Fatal("★ 有真实 SKILL.md 却判定为没有 skill")
|
||||
}
|
||||
}
|
||||
|
||||
// ★★★ 判据：cmd_build 里必须真的拦住 auto_start=false 且无 skill 的情况。
|
||||
func TestBuildRejectsOnDemandWithoutSkill(t *testing.T) {
|
||||
b, err := os.ReadFile("cmd_build.go")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
src := string(b)
|
||||
|
||||
i := strings.Index(src, `if plg.AutoStart != nil && !*plg.AutoStart {`)
|
||||
if i < 0 {
|
||||
t.Fatal("找不到 auto_start 的写入分支")
|
||||
}
|
||||
body := src[i:]
|
||||
if j := strings.Index(body[1:], "\n\t}\n"); j > 0 {
|
||||
body = body[:j+3]
|
||||
}
|
||||
if !strings.Contains(body, "hasSkillDir") {
|
||||
t.Fatal("★ auto_start=false 的分支没有校验 skill —— " +
|
||||
"按需插件缺 skill 等价于没装（agent 不知道它存在）")
|
||||
}
|
||||
if !strings.Contains(body, "os.Exit(1)") {
|
||||
t.Fatal("★ 校验没有中断打包（os.Exit(1)）—— 报错了还继续产出不可用包")
|
||||
}
|
||||
}
|
||||
@ -377,6 +377,24 @@ func writePluginJSON(plg *PlgConfig, platforms []string, entry string) {
|
||||
}
|
||||
// auto_start：只有**显式 false** 才写（缺省 true 与旧行为一致，不写字段最兼容）
|
||||
if plg.AutoStart != nil && !*plg.AutoStart {
|
||||
// ★★ auto_start=false 的插件**必须**带 skill，否则等价于没装。
|
||||
//
|
||||
// 逻辑链：
|
||||
// auto_start=false ⇒ 内核启动时不拉起它 ⇒ 它的工具不出现在
|
||||
// 工具的初始清单里 ⇒ 模型不知道它存在 ⇒ 永远不会被调用，
|
||||
// 也永远不会被拉起。
|
||||
//
|
||||
// 也就是说缺 skill 的按需插件**等价于没装**，但比没装更糟：
|
||||
// 它占着磁盘和安装记录，让人以为它可用。
|
||||
//
|
||||
// 所以这不是"建议配 skill"，而是"没有 skill 就不该声明按需加载"。
|
||||
// 在**打包期**拦住，比等用户装上后困惑早得多。
|
||||
if !hasSkillDir(".") {
|
||||
fmt.Printf(" error: auto_start=false 但没有 skill/ 目录 —— " +
|
||||
"按需加载的插件必须配 skill 说明\"先 plugin_enable 再调用\"" +
|
||||
"，否则 agent 不知道它存在（等价于没装）\n")
|
||||
os.Exit(1)
|
||||
}
|
||||
m["auto_start"] = false
|
||||
}
|
||||
data, _ := json.MarshalIndent(m, "", " ")
|
||||
@ -687,8 +705,32 @@ func buildTarget(plg *PlgConfig, target, outDir, sdkPath string) {
|
||||
}
|
||||
}
|
||||
hmapName := fmt.Sprintf("%s_lua.hmap", toSnake(plg.NameEn))
|
||||
createHmap(filepath.Join(outDir, hmapName), pkgFiles)
|
||||
|
||||
// ★ Lua 插件以前**完全不走** rawfile/skill 收集（直接 createHmap），
|
||||
// 于是 luademo 这类 Lua 插件永远带不上 skill —— 而 skill 是 Lua
|
||||
// 插件唯一能向 agent 说明自己的途径（它没有 Go 侧 RegisterTool 那么
|
||||
// 直观的文档位）。实测：加了 skill/luademo-tools/SKILL.md 后，
|
||||
// 打出的 linux_amd64_lua_demo_lua.hmap 里 skill 条目数为 0。
|
||||
//
|
||||
// 与 Go 路径对齐：收集 rawfile（工程根 rawfile/ 默认全收）与 skill。
|
||||
raws, rerr := collectRawFiles(".", plg.RawFiles)
|
||||
if rerr != nil {
|
||||
fmt.Printf(" error: rawfiles: %v\n", rerr)
|
||||
return
|
||||
}
|
||||
skills, serr := collectSkillFiles(".")
|
||||
if serr != nil {
|
||||
fmt.Printf(" error: skills: %v\n", serr)
|
||||
return
|
||||
}
|
||||
createHmapWithRaw(filepath.Join(outDir, hmapName), pkgFiles, append(raws, skills...))
|
||||
fmt.Printf(" packaged %s\n", hmapName)
|
||||
if len(raws) > 0 {
|
||||
fmt.Printf(" 已打包 %d 个 rawfile\n", len(raws))
|
||||
}
|
||||
if len(skills) > 0 {
|
||||
fmt.Printf(" 已打包 %d 个 skill 文件\n", len(skills))
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
84
tools/hmapdev/lua_skill_packaging_test.go
Normal file
84
tools/hmapdev/lua_skill_packaging_test.go
Normal file
@ -0,0 +1,84 @@
|
||||
package main
|
||||
|
||||
// Lua 插件的打包路径也必须收集 skill。
|
||||
//
|
||||
// ## 缺陷（2026-10-18 实测）
|
||||
//
|
||||
// `buildTarget` 里 Go 路径会调 collectRawFiles + collectSkillFiles，
|
||||
// 而 **Lua 路径是另一段代码**，直接 `createHmap(out, pkgFiles)` ——
|
||||
// 完全不走 rawfile/skill 收集。
|
||||
//
|
||||
// 实测：给 luademo 加了 skill/luademo-tools/SKILL.md 后，
|
||||
// 打出的 `linux_amd64_lua_demo_lua.hmap` 里 skill 条目数为 **0**。
|
||||
//
|
||||
// 这对 Lua 插件伤害更大：Go 插件至少有 RegisterTool 的 Description
|
||||
// 作为文档位，而 Lua 插件向 agent 说明自己的**唯一**途径就是 skill。
|
||||
// 缺了它，一个功能完整的 Lua 插件对模型来说是隐形的。
|
||||
//
|
||||
// ## 判据
|
||||
//
|
||||
// 断言 Lua 分支里出现 collectRawFiles + collectSkillFiles，
|
||||
// 并且最终走 createHmapWithRaw（而不是只包 pkgFiles 的 createHmap）。
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// ★★★ 判据：Lua 打包分支必须收集 rawfile 与 skill。
|
||||
func TestLuaPackagingCollectsSkillAndRawfiles(t *testing.T) {
|
||||
b, err := os.ReadFile("cmd_build.go")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
src := string(b)
|
||||
|
||||
// 定位 Lua 分支：`if target == "lua" {` 之后到 `// Resolve build config`
|
||||
i := strings.Index(src, `if target == "lua" {`)
|
||||
if i < 0 {
|
||||
t.Fatal("找不到 Lua 打包分支")
|
||||
}
|
||||
// ★ 结束边界必须是 Lua 分支自己的 `return` + `}`，不能用
|
||||
// "// Resolve build config" —— 实测那个注释在文件里**出现多次**
|
||||
// （Go 路径里也有），用它截取会把 Go 分支一起包进来，
|
||||
// 于是"Lua 分支没传 skills"这种变异测不出来。
|
||||
endMark := "\t\tfmt.Printf(\" packaged %s\\n\", hmapName)"
|
||||
j := strings.Index(src[i:], "\t\treturn\n\t}")
|
||||
if j < 0 {
|
||||
t.Fatal("找不到 Lua 分支的结束位置")
|
||||
}
|
||||
// 更稳妥：截到该分支的第一个 `\n\t}\n\n\t// Resolve` 之前。
|
||||
lua := src[i : i+j]
|
||||
_ = endMark
|
||||
|
||||
// ★★ 只查符号存在是不够的（实测：把 createHmapWithRaw 换回 createHmap，
|
||||
// 判据依然通过 —— 因为那行 `createHmapWithRaw` 的字符串还在注释里）。
|
||||
// 必须断言：收集到的 raws/skills 确实**传给了** createHmapWithRaw。
|
||||
for _, want := range []struct{ sym, why string }{
|
||||
{"collectRawFiles", "Lua 插件带不上 rawfile（随包资源全部丢失）"},
|
||||
{"collectSkillFiles", "Lua 插件带不上 skill（它对模型来说是隐形的）"},
|
||||
} {
|
||||
if !strings.Contains(lua, want.sym) {
|
||||
t.Fatalf("★ Lua 打包分支缺少 %s —— %s", want.sym, want.why)
|
||||
}
|
||||
}
|
||||
|
||||
// 必须是**代码行**在调用 createHmapWithRaw，且参数里带上了 skills。
|
||||
// 逐行查（跳过注释），避免"注释里有、代码里没有"。
|
||||
callOK := false
|
||||
for _, ln := range strings.Split(lua, "\n") {
|
||||
code := strings.TrimSpace(ln)
|
||||
if strings.HasPrefix(code, "//") {
|
||||
continue
|
||||
}
|
||||
if strings.Contains(code, "createHmapWithRaw(") && strings.Contains(code, "skills") {
|
||||
callOK = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !callOK {
|
||||
t.Fatal("★ Lua 打包没有把 skill 传给 createHmapWithRaw —— " +
|
||||
"收集到了却没写进包，Lua 插件对模型来说仍是隐形的")
|
||||
}
|
||||
}
|
||||
@ -127,3 +127,24 @@ func skillFilesSummary(ents []rawEntry) string {
|
||||
return fmt.Sprintf("%d 个 skill（%s，共 %d 个文件）",
|
||||
len(list), strings.Join(list, ", "), len(ents))
|
||||
}
|
||||
|
||||
// hasSkillDir 判断工程根是否有**至少一个真实 skill**（供打包期校验用）。
|
||||
//
|
||||
// 为什么不用简单的 os.Stat(SkillDir)：空目录、只有 .gitkeep 的脚手架目录
|
||||
// 都会让它返回 true，而那种情况下 agent 一样拿不到任何说明 ⇒ 校验形同虚设。
|
||||
// 这里复用 collectSkillFiles 的实际收集结果，与打包时的判定**同源**，
|
||||
// 避免"校验说有、打包说没有"的分叉。
|
||||
func hasSkillDir(root string) bool {
|
||||
files, err := collectSkillFiles(root)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
// 收集到的条目里必须真的有 SKILL.md 才算一个可用 skill：
|
||||
// 只有目录没有说明文件的条目，注册到 skillmgr 也是空壳。
|
||||
for _, f := range files {
|
||||
if strings.HasSuffix(f.zip, "SKILL.md") {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
@ -99,6 +99,14 @@ type ToolDef struct {
|
||||
// TestMockSDKToolDefMatchesSDK 钉住这一致。
|
||||
ParallelSafe bool `json:"parallel_safe,omitempty"`
|
||||
Serial bool `json:"serial,omitempty"`
|
||||
|
||||
// Timeout 是工具自声明的超时（如 "5m"）。
|
||||
//
|
||||
// 与公共 SDK 的 ToolDef.Timeout 逐字对齐：内核按
|
||||
// max(声明值, 参数里的 timeout) 计算，并夹到 10 分钟上限。
|
||||
// 缺这个字段，本地 yaegi 调试时写 Timeout 不报错，
|
||||
// 装到内核后却发现声明被忽略（超时仍是一刀切的默认值）。
|
||||
Timeout string `json:"timeout,omitempty"`
|
||||
}
|
||||
|
||||
// 上下文策略取值，与公共 SDK 一致。
|
||||
|
||||
Reference in New Issue
Block a user