mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-30 14:23:00 +00:00

Files

JianFeeeee a176cc3e20 feat(sdk): 反代声明（ProxyDef / RegisterProxy）—— 插件声明服务，HomeAgent 反代出去

配套核心仓「webui 通用反向代理」。SDK 1.4.0 尚未发布，接口未冻结，
本次按开发期自由变更处理（正式发版时并入版本号推进）。

## 声明契约

plugin.json 的 proxies 字段（声明式，静态可发现）或 RegisterProxy
（运行期，供没有 plugin.json 的内置插件用）：

    {"name":"ui","host":"myapp","path":"/p/myapp","strip_path":true,
     "target":"127.0.0.1:12100","auth":"homeagent"}

命名与既有能力对齐（ToolDef / ChannelDef / ConfigDef / RegisterTool /
ToolRegistrar）——第一版写成 ProxyDecl / DeclareProxy / ProxyDeclarer
被评审指出「跟 SDK 其他接口不是一个风格」，已全面改名。

## strip_path：Path 的两种语义

Path 不能一刀切成「原样保留」，真实需求有两种且**不能自动判定**
（同一个 path 在两种语义下都说得通，猜错即全部 404 且像上游故障）：

  strip_path 缺省/false（别名模式）—— path 是上游真实路径的一部分
    /api/v1/device/ws + path=/api/v1/device → 上游收到原样
    适用：客户端**已硬编码**路径的机器接口（设备网关即如此）

  strip_path=true（前缀模式）—— path 只是门户上的挂载点
    /p/myapp/api/status + path=/p/myapp → 上游收到 /api/status
    适用：自带 UI 的服务（前端用相对路径）

非法组合（strip_path 而无 path）被 ValidateProxyDef 挡住。

## 单一入口原则（契约级要求）

一个声明 = 一个入口。两种挂载形态对「根路径」处理截然不同：
Host 形态下根路径是插件的根（fetch('/api/x') 天然正确）；
Path 形态下根路径**属于门户**，同样代码会打到门户自己身上
（静默错路由：页面能开、功能全坏）。

故被反代的插件必须**一律使用相对路径**，绝不硬编码以 / 开头的绝对路径。
这样同一份前端在两种形态下都正确，插件不必知道自己被挂在哪，
反代层也能按外部条件（子域是否有证书/放行）自由选择形态。

## 判据

sdk/proxy_test.go：两种语义的映射、非法组合、单一入口原则的契约存在性。
hmapdev proxy_config_test.go：schema 漂移保护（新增字段忘了同步就判红）、
非法声明在**打包时**就被拒（不必装到 HomeAgent 才看到）。

两模块 go test 全绿；文档站已重新生成（ProxyDef 与单一入口原则进入
docs/api/misc.md 与 llms-full.txt）。

## 顺带修回的一处（此前随工作树丢失）

writePluginJSON 漏写 proxies 键 —— 漏写的话插件装得上、启动正常、
就是不出现，没有任何报错。该 bug 曾在核心仓侧出现过（判据抓到过），
这次移植时由 TestWritePluginJSONPreservesProxies 再次判红并修复。

2026-09-26 14:08:30 +08:00

2.4 KiB

Raw Blame History

工具（Tools）

`ContentBlock`

type ContentBlock struct { Type string `json:"type"` Text string `json:"text,omitempty"` ImageURL *ImageURL `json:"image_url,omitempty"` AudioURL *AudioURL `jso …

ContentBlock 是多模态内容块（OpenAI 格式：text/image_url/audio_url）。插件工具返回结果时可用 PluginSDK.SetToolBlocks 注入，让下一轮 LLM 请求在 tool message 的 content 数组里带上图片/音频，实现"模型看图/听音频"。

plugin.go:855

`PluginSDK.RegisterTool`

func (s *PluginSDK) RegisterTool(name string, def ToolDef, handler ToolHandler) error

RegisterTool registers a tool that the LLM can call.

示例插件里的真实用法

插件	位置	代码
`a2a`	`example/a2a/plugin.go:76`	`s.RegisterTool(tp+"a2a_query", sdk.ToolDef{`
`acp`	`example/acp/plugin.go:70`	`s.RegisterTool(tp+"acp_query", sdk.ToolDef{`
`ai_image`	`example/ai_image/plugin.go:159`	`s.RegisterTool(tp+"generate", sdk.ToolDef{`
`bili`	`example/bili/plugin.go:47`	`s.RegisterTool(tp+"video", sdk.ToolDef{`

plugin.go:458

`ToolCall`

type ToolCall struct { ID string `json:"id"` Name string `json:"name"` Plugin string `json:"plugin,omitempty …

ToolCall represents a model's request to call a tool.

plugin.go:186

`ToolDef`

type ToolDef struct { Name string `json:"name"` Plugin string `json:"plugin,omitempty"` Description string …

ToolDef describes a tool that the plugin exposes.

plugin.go:203

`ToolHandler`

type ToolHandler func(args map[string]interface{}) (interface{}, error)

ToolHandler is a function that handles a tool call.

plugin.go:20

`ToolResult`

type ToolResult struct { CallID string `json:"call_id"` Name string `json:"name"` Plugin string `json:"plugin,omitempty"` Success bool `json:"suc …

ToolResult represents the result of a tool call.

plugin.go:194

2.4 KiB Raw Blame History Unescape Escape

工具（Tools）

ContentBlock

PluginSDK.RegisterTool

ToolCall

ToolDef

ToolHandler

ToolResult