jianf/homeagent-sdk
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-30 06:13:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5759e58bad7d550590cf0c500f189ddd5f73affe
homeagent-sdk/docs/api/lifecycle.md
JianFeeeee 82e8d9dbac docs: 补两篇指南 —— 工具并发声明、流式多 tool_call 
`ParallelSafe` / `Serial` / `stream_index` 三个新能力此前**零文档**：
README 提到 `Serial` 的那处是 UART 串口，与并发声明无关。插件作者只能
读源码注释才能知道这些字段存在及其优先级。

## docs/guide/parallel-tool-declaration.md

- 保守 opt-in 的理由：存量插件不改一行就得串行，不会被升级意外并发
- 声明 `ParallelSafe` 的三个条件（线程安全 / 不争抢资源 / 顺序无关）
- `Serial` 存在的意义：让"我确认过**必须**串行"与"我没想过"可区分
- **`Serial` 胜出**，不允许被 `ParallelSafe` 或默认值覆盖
- 声明字段放在 `ToolDef` 末尾，遵循既有 `NoMemory` 风格
- 压测效果 N=2/4/8 → 1.41×/2.22×/3.88×，并附"必须同时统计实际执行数"
  的理由（旧适配器耗时更短但实际处理 0 个工具）

## docs/guide/stream-tool-call-index.md

面向写 Lua 适配器的人：

- 上游 `index` 字段的用途：分桶累积 `id`/`name`/`arguments`
- **键名是 `stream_index` 不是 `index`** —— 写错会被 Go 解码器静默丢弃
- 不透传的实际后果：name 互相覆盖、args 碎片混拼、工具被当空参数调用
- 顺带记两个易踩点：不能按 name 过滤分片；扁平结构的协议族同样要带
- 自检命令；并注明 `gemini.lua` 不涉及（协议是 `functionCall`）

## 其它

- `mkdocs.yml` nav 登记两篇 —— 之前它们会被 mkdocs 明确警告
  "not included in the nav configuration"，等于在站点里不可达
- 重跑 `tools/apidoc/build.sh` 同步 `docs/api/*`、`llms.txt`（生成物）

核实过的事实，避免臆造：
- 内置工具声明是**核心仓**的 `toolDefOptions`/`parallelOpts()`
  （`internal/agent/core/tooldefs.go`），不是 `sdk.BuiltinToolDef` —— 初稿写错
- `gemini.lua` 对 `functionCall|tool_calls` 匹配数为 0，确认无流式实现
- `server/kimicode/anthropic/ollama` 四个适配器确有 `stream_index`（2~5 处）
- 跨仓相对链接不可解析，故改为纯文本路径指路

`docs/api/tools.md` 属生成物（首行注明"请勿手改"），其 `ToolDef` 签名被截断、
不展示字段 —— 这是生成器既有行为，本次 diff 只是行号漂移，未改它。
2026-09-27 22:25:38 +08:00

5.7 KiB
Raw Blame History

生命周期（Lifecycle）

插件的启动、停止与卸载回调。停止与卸载是两件事：停止是进程/加载状态变化，卸载（onRemove）是插件被删除前的清理机会。

Plugin

Plugin is the interface every plugin must implement.

方法 说明
Name
Start
Stop

Plugin.Name

Name() string

plugin.go:14

Plugin.Start

Start(sdk *PluginSDK) error

plugin.go:15

Plugin.Stop

Stop() error

plugin.go:16

PluginMgrAPI

PluginMgrAPI 提供插件管理能力（外部插件可调用）。 由 bridge 注入 dispatch 实现，走 C ABI CORE_PLUGIN_RELOAD_ONE 等。

方法 说明
IsPluginDisabled IsPluginDisabled 查询插件是否被禁用。
ListLoadedPlugins ListLoadedPlugins 列出已加载插件。
ReloadOne ReloadOne 重载单个插件（停止后重新加载）。

PluginMgrAPI.IsPluginDisabled

IsPluginDisabled(name string) bool

IsPluginDisabled 查询插件是否被禁用。

plugin.go:389

PluginMgrAPI.ListLoadedPlugins

ListLoadedPlugins() []string

ListLoadedPlugins 列出已加载插件。

plugin.go:387

PluginMgrAPI.ReloadOne

ReloadOne(name string) error

ReloadOne 重载单个插件（停止后重新加载）。

plugin.go:385

PluginSDK.AutoRestart

func (s *PluginSDK) AutoRestart() bool

AutoRestart 返回插件是否允许自动重启。

plugin.go:895

PluginSDK.PluginMgr

func (s *PluginSDK) PluginMgr() PluginMgrAPI

PluginMgr returns the plugin manager API (ReloadOne / ReloadPlugins / list). May be nil if the host did not wire it.

plugin.go:757

PluginSDK.PluginName

func (s *PluginSDK) PluginName() string

PluginName returns the name of the plugin.

plugin.go:501

PluginSDK.RegisterOnRemoveHandler

func (s *PluginSDK) RegisterOnRemoveHandler(fn func())

RegisterOnRemoveHandler 注册插件被删除（卸载）时的清理回调。 注册的 handler 会在插件目录被移除前按"后注册先执行"的顺序调用， 适用于清理外部资源、删除配置表、下线状态等删除后处理。 可注册多个；执行后清空（一次删除只执行一次）。

示例插件里的真实用法

插件 位置 代码
calendar example/calendar/plugin.go:296 s.RegisterOnRemoveHandler(p.cleanupData)
memo example/memo/plugin.go:69 s.RegisterOnRemoveHandler(p.cleanupData)
rss example/rss/plugin.go:127 s.RegisterOnRemoveHandler(p.cleanupData)

plugin.go:930

PluginSDK.RegisterPluginAPI

func (s *PluginSDK) RegisterPluginAPI(name string) error

RegisterPluginAPI registers this plugin's API for access by other plugins.

plugin.go:606

PluginSDK.RegisterStopHandler

func (s *PluginSDK) RegisterStopHandler(fn func())

RegisterStopHandler 注册插件停止阶段的清理回调。 注册的 handler 会在插件 Stop() 之前按"后注册先执行"的顺序调用， 适用于释放资源、落盘状态、关闭子进程等停止时清理操作。 可注册多个；执行后清空（进程停止前只执行一次）。

示例插件里的真实用法

插件 位置 代码
calendar example/calendar/plugin.go:294 s.RegisterStopHandler(p.saveEvents)
deepsearch example/deepsearch/plugin.go:695 s.RegisterStopHandler(func() { p.shutdownSearxng() })

plugin.go:905

PluginSDK.RunOnRemoveHandlers

func (s *PluginSDK) RunOnRemoveHandlers()

RunOnRemoveHandlers 执行全部已注册的 onRemove handler（后注册先执行，执行后清空，幂等）。 由内核在卸载插件（registry.RemovePlugin）时、插件 Stop() 之后执行。

plugin.go:941

PluginSDK.RunStopHandlers

func (s *PluginSDK) RunStopHandlers()

RunStopHandlers 执行全部已注册的 stop handler（后注册先执行，执行后清空，幂等）。 由内核（内置插件）或插件桥接层（外部插件 z_bridge 的 StopPlugin）在调用插件 Stop() 前执行。

plugin.go:916

PluginSDK.SetAutoRestart

func (s *PluginSDK) SetAutoRestart(enabled bool)

SetAutoRestart 设置插件崩溃后内核是否自动重启它。 默认 true。如果插件有无法恢复的状态（如外部连接），应设为 false。

重启是有限度的：线性退避（第 n 次等 n×1s，即 1s→2s→3s）， 且同一 5 分钟窗口内第 4 次崩溃就停下不再拉起（详见 README）。 注意这与「重载」（换 plugin.bin 后重新加载）是两回事。

示例插件里的真实用法

插件 位置 代码
a2a example/a2a/plugin.go:47 s.SetAutoRestart(true)
acp example/acp/plugin.go:47 s.SetAutoRestart(true)
ai_image example/ai_image/plugin.go:110 s.SetAutoRestart(true)
bili example/bili/plugin.go:63 s.SetAutoRestart(true)

plugin.go:888