mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-25 03:18:06 +00:00

Files

JianFeeeee 0a6e2b7dc4 docs: 插件 SDK 文档站（API 参考从源码生成 + 自建检索）

为插件作者建一个文档站，重点是**能按描述搜到 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`（预览）。

2026-09-24 12:08:37 +08:00

4.4 KiB

Raw Blame History

阶段钩子（Stages）

在消息处理管道的固定点位插入自己的逻辑。阶段比工具更底层：工具是模型主动调用的，阶段是流程经过时必然触发的。

`StageContext.IsResponded`

func (c *StageContext) IsResponded() bool

plugin.go:172

`StageContext.Lock`

func (c *StageContext) Lock()

示例插件里的真实用法

插件	位置	代码
`a2a`	`example/a2a/plugin.go:158`	`p.sessMu.Lock()`
`acp`	`example/acp/plugin.go:128`	`p.srvMu.Lock()`
`browser`	`example/browser/plugin.go:427`	`p.mu.Lock()`
`calendar`	`example/calendar/plugin.go:433`	`p.mu.Lock()`

plugin.go:170

`StageContext.RLock`

func (c *StageContext) RLock()

示例插件里的真实用法

插件	位置	代码
`acp`	`example/acp/plugin.go:267`	`p.mu.RLock()`
`calendar`	`example/calendar/plugin.go:649`	`p.mu.RLock()`
`memo`	`example/memo/plugin.go:224`	`p.mu.RLock()`
`qq`	`example/qq/plugin.go:1152`	`ctx.RLock()`

plugin.go:168

`StageContext.RUnlock`

func (c *StageContext) RUnlock()

示例插件里的真实用法

插件	位置	代码
`acp`	`example/acp/plugin.go:273`	`p.mu.RUnlock()`
`calendar`	`example/calendar/plugin.go:650`	`defer p.mu.RUnlock()`
`memo`	`example/memo/plugin.go:229`	`p.mu.RUnlock()`
`qq`	`example/qq/plugin.go:1155`	`ctx.RUnlock()`

plugin.go:169

`PluginSDK.RegisterStage`

func (s *PluginSDK) RegisterStage(stage Stage, handler StageHandler, scope ...StageScope)

RegisterStage registers a handler for a pipeline stage.

scope: StageScopeGlobal (default) — receives all stage events.
       StageScopeOwnTools — only before_toolcall/after_toolcall for this plugin's tools.

示例插件里的真实用法

插件	位置	代码
`memo`	`example/memo/plugin.go:152`	`s.RegisterStage(sdk.StagePreAction, p.stagePreAction)`
`qq`	`example/qq/plugin.go:719`	`s.RegisterStage(sdk.StageOnInput, p.onInputAuthContext, sdk.StageScopeGlobal)`
`sanitizer`	`example/sanitizer/plugin.go:52`	`s.RegisterStage(sdk.StageOnInput, func(ctx *sdk.StageContext) error {`
`weather`	`example/weather/plugin.go:94`	`s.RegisterStage(sdk.StageAfterToolcall, func(ctx *sdk.StageContext) error {`

plugin.go:467

`Stage`

type Stage string

Stage represents a point in the message processing pipeline.

plugin.go:26

`StageContext`

type StageContext struct { mu sync.RWMutex RawMessage string UserID string GroupID string ContextMsgs []map[string]interface{} L …

StageContext provides context for stage handlers.

plugin.go:148

`StageHandler`

type StageHandler func(ctx *StageContext) error

StageHandler is a function that handles a pipeline stage event.

plugin.go:23

`StageRegistrar`

type StageRegistrar func(stage Stage, handler StageHandler)

StageRegistrar registers a stage handler.

plugin.go:308

`StageScope`

type StageScope int

StageScope controls which events a stage handler receives.

plugin.go:294

`StageContext.Unlock`

func (c *StageContext) Unlock()

示例插件里的真实用法

插件	位置	代码
`a2a`	`example/a2a/plugin.go:164`	`p.sessMu.Unlock()`
`acp`	`example/acp/plugin.go:129`	`defer p.srvMu.Unlock()`
`browser`	`example/browser/plugin.go:432`	`p.mu.Unlock()`
`calendar`	`example/calendar/plugin.go:523`	`p.mu.Unlock()`

plugin.go:171

4.4 KiB Raw Blame History Unescape Escape

阶段钩子（Stages）

StageContext.IsResponded

StageContext.Lock

StageContext.RLock

StageContext.RUnlock

PluginSDK.RegisterStage

Stage

StageContext

StageHandler

StageRegistrar

StageScope

StageContext.Unlock

4.4 KiB

Raw Blame History

`StageContext.IsResponded`

`StageContext.Lock`

`StageContext.RLock`

`StageContext.RUnlock`

`PluginSDK.RegisterStage`

`Stage`

`StageContext`

`StageHandler`

`StageRegistrar`

`StageScope`

`StageContext.Unlock`