mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-25 19:38:06 +00:00
0a6e2b7dc4
为插件作者建一个文档站，重点是**能按描述搜到 API**，以及**明确能力边界**。
## 为什么 API 参考要生成而不是手写
公开 API 面有 115 个符号、11 个接口。手抄必然与代码漂移——这是文档站最常见的
死法（本仓 README 里已经有过几处「文档说一套、代码是另一套」）。
所以 `tools/apidoc` 直接从 `sdk/*.go` 提取签名、文档注释与代码块示例，渲染成
`docs/api/*.md`。发现文档不对时改的是**源码注释**，不是生成物。生成页首行带
「勿手改」标记，防止有人改了下次构建白改。
- `extract.go`：go/ast + go/doc 提取（只用标准库，离线可跑，不引入依赖）
- `gensite/`：渲染 Markdown + 检索索引
- `gensite/usages.go`：从 `example/` 21 个示例插件里反查**真实调用点**，
贴在每个 API 下（源码注释里几乎没有可运行示例，但示例插件都是能编译跑的真代码）
## 能力边界：写这个站时查出的三处文档错误
这是本次最有价值的部分。原以为「公开 SDK 里有的 API 外部插件都能用」，
实测对照桥接模板后发现三处不符，站内已更正：
1. **`PluginMgr()` 被写成「仅内置可用」——错的。** 桥接模板第 692 行显式
`base.SetPluginMgrAPI(procPluginMgr{})`，公开 `PluginMgrAPI` 注释也写「外部插件可调用」。
真正的区别是**方法数**：公开面 3 个（ReloadOne/ListLoadedPlugins/IsPluginDisabled），
内部面 9 个。容易混淆是因为两个包里有同名但不同的接口。
2. **`Events()` 外部插件恒为 nil。** `SetEventSubscriber` 全仓只有定义、无调用点，
故 subscriber 从未被注入。外部插件的事件订阅实际由生成的运行时走
`events.subscribe` RPC 完成——旧文档把它当成可用入口，会让人写出必然失效的代码。
3. **`UnregisterOutputChannel` 是静默无效，不是报错。** 桥接只注入 registrar、
不注入 unregistrar，于是 `regOutputUnreg == nil`，函数命中 else 分支**直接返回 nil**
（sdk/plugin.go:539-549）——不报错、通道也没注销。
每条裁定的依据写进 `tools/apidoc/tiers.json`（文件:行号 或 grep 结论），
站上以告警框呈现，读者可自行核对。判断依据三源：桥接模板的 `base.Set*` 注入点、
`internal/sdk` 完整面、`internal/plugin/proc/protocol.go` 的 RPC 表。
## 检索（用户的核心诉求）
两套互补：
- **MkDocs 内置搜索**：全文，中文走 jieba 分词。
- **自建 API 检索**（`docs/javascripts/api-search.js` + `assets/api-index.json`）：
支持四类查询——按名称、**按功能描述**（「注册工具」→ RegisterTool、
「崩溃」→ SetAutoRestart）、按 `限定符.方法`（`memory.recall` → MemoryAPI.Recall）、
按签名片段（`(string) error`）。并标出「仅内置」，避免外部插件作者踩空。
自建的理由：Material 内置搜索按整页文本索引，搜 `InjectText` 会列出所有提到它的
页面，但分不清哪条是它的定义；而且它要等 mkdocs build 才更新。
## 文档结构
- `docs/guide/`：快速开始、Go/Lua 首个插件、能力边界、打包发布、多平台、受限 SDK 与安全
- `docs/api/`：10 个按「你想做什么」划分的章节（工具/阶段/记忆/通道/配置/生命周期/
事件/LLM/常量/桥接）+ 仅内置汇总页
- `docs/versions.md`：SDK 版本语义（跟随内核中版本、patch 恒为 .0）、
1.0.0 是唯一破坏性变更、RPC 协议版本
## 验证
- `mkdocs build --strict` 零告警
- 23 个页面的全部站内链接与锚点可达（自动校验）
- 1440 / 768 / 390px 三视口：无横向溢出、无控制台错误
- 四种检索模式实测有结果且跳转锚点正确
- 构建产物 `site_build/` 已 gitignore
用法：`tools/apidoc/build.sh`（生成+构建）、`tools/apidoc/build.sh serve`（预览）。
205 lines
5.3 KiB
Markdown
205 lines
5.3 KiB
Markdown
<!-- 本页由 tools/apidoc/gensite 从源码生成，请勿手改；要改文档就改 sdk/*.go 的注释。 -->
|
||
|
||
# 桥接装配点（Bridge）
|
||
|
||
以下方法**不是给插件业务代码调的**——它们由 `hmapdev` 生成的运行时在启动时调用，用来把内核能力注入到 SDK 实例。列在这里是为了让「公开 API 面」完整，并说明每个注入点对应什么能力。
|
||
|
||
### `APIRegistrar`
|
||
|
||
```go
|
||
type APIRegistrar func(name string) error
|
||
```
|
||
|
||
APIRegistrar registers a plugin API for external access.
|
||
|
||
<small>`plugin.go:311`</small>
|
||
|
||
### `InputChannelRegistrar`
|
||
|
||
```go
|
||
type InputChannelRegistrar func(name string, def ChannelDef) error
|
||
```
|
||
|
||
InputChannelRegistrar registers an input channel with its memory behavior.
|
||
|
||
<small>`plugin.go:314`</small>
|
||
|
||
### `OutputChannelRegistrar`
|
||
|
||
```go
|
||
type OutputChannelRegistrar func(name string, caps int, desc string, def ChannelDef, handler ToolHandler) error
|
||
```
|
||
|
||
OutputChannelRegistrar registers an output channel that the output_send tool can use.
|
||
|
||
<small>`plugin.go:317`</small>
|
||
|
||
### `OutputChannelUnregistrar`
|
||
|
||
```go
|
||
type OutputChannelUnregistrar func(name string) error
|
||
```
|
||
|
||
OutputChannelUnregistrar 注销一个输出通道。
|
||
|
||
为什么需要它：输出通道不止有"启动时注册一次"的静态通道，还有**随外部资源生灭**的
|
||
动态通道 —— 典型是远程设备：`device/<id>` 只在设备在线期间存在，设备掉线后
|
||
必须注销，否则 output_list_channels 会一直列着它、模型会往一个死通道发消息。
|
||
|
||
<small>`plugin.go:324`</small>
|
||
|
||
### `PluginSDK.SetDocMemoryAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetDocMemoryAPI(dm DocMemoryAPI)
|
||
```
|
||
|
||
<small>`plugin.go:614`</small>
|
||
|
||
### `PluginSDK.SetEventSubscriber`
|
||
|
||
!!! warning "仅内核内置插件可用"
|
||
同上：无调用点。标 builtin 而非 bridge，因为连桥接运行时都不注入它——外部插件无法用它获得事件订阅能力。
|
||
|
||
```go
|
||
func (s *PluginSDK) SetEventSubscriber(es EventSubscriber)
|
||
```
|
||
|
||
<small>`plugin.go:638`</small>
|
||
|
||
### `PluginSDK.SetIOInjector`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetIOInjector(io IOInjector)
|
||
```
|
||
|
||
SetIOInjector sets the IO injector (called by the core at startup).
|
||
|
||
<small>`plugin.go:595`</small>
|
||
|
||
### `PluginSDK.SetInputChannelRegistrar`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetInputChannelRegistrar(r InputChannelRegistrar)
|
||
```
|
||
|
||
SetInputChannelRegistrar sets the input channel registrar (called by the core at startup).
|
||
|
||
<small>`plugin.go:588`</small>
|
||
|
||
### `PluginSDK.SetKnowledgeAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetKnowledgeAPI(kn KnowledgeAPI)
|
||
```
|
||
|
||
<small>`plugin.go:620`</small>
|
||
|
||
### `PluginSDK.SetLLMAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetLLMAPI(llm LLMAPI)
|
||
```
|
||
|
||
<small>`plugin.go:626`</small>
|
||
|
||
### `PluginSDK.SetMemoryAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetMemoryAPI(mem MemoryAPI)
|
||
```
|
||
|
||
SetMemoryAPI sets the memory API (called by the core at startup).
|
||
|
||
<small>`plugin.go:602`</small>
|
||
|
||
### `PluginSDK.SetOutputChannelRegistrar`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetOutputChannelRegistrar(r OutputChannelRegistrar)
|
||
```
|
||
|
||
SetOutputChannelRegistrar sets the output channel registrar (called by the core at startup).
|
||
|
||
<small>`plugin.go:574`</small>
|
||
|
||
### `PluginSDK.SetOutputChannelUnregistrar`
|
||
|
||
!!! warning "仅内核内置插件可用"
|
||
同上，桥接模板不注入。
|
||
|
||
```go
|
||
func (s *PluginSDK) SetOutputChannelUnregistrar(r OutputChannelUnregistrar)
|
||
```
|
||
|
||
SetOutputChannelUnregistrar sets the output channel unregistrar (called by the core at startup).
|
||
|
||
<small>`plugin.go:581`</small>
|
||
|
||
### `PluginSDK.SetPluginMgrAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetPluginMgrAPI(pm PluginMgrAPI)
|
||
```
|
||
|
||
SetPluginMgrAPI sets the plugin manager API (called by the bridge at startup).
|
||
|
||
<small>`plugin.go:645`</small>
|
||
|
||
### `PluginSDK.SetSocialAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetSocialAPI(social SocialAPI)
|
||
```
|
||
|
||
<small>`plugin.go:632`</small>
|
||
|
||
### `PluginSDK.SetTextMemoryAPI`
|
||
|
||
!!! info "桥接装配点"
|
||
桥接运行时注入点（由 hmapdev 生成的 proc_main 调用，插件业务代码不调用）
|
||
|
||
```go
|
||
func (s *PluginSDK) SetTextMemoryAPI(tm TextMemoryAPI)
|
||
```
|
||
|
||
<small>`plugin.go:608`</small>
|
||
|
||
### `ToolRegistrar`
|
||
|
||
```go
|
||
type ToolRegistrar func(name string, def ToolDef, handler ToolHandler) error
|
||
```
|
||
|
||
ToolRegistrar registers a tool dynamically.
|
||
|
||
<small>`plugin.go:305`</small>
|
||
|