82e8d9dbac
`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 只是行号漂移，未改它。
4.9 KiB
配置（Settings）
声明插件自己的配置项，内核会把它渲染到 WebUI 的设置页，并为每个插件维护独立的配置表。
SettingsAPI
| 方法 | 说明 |
|---|---|
DataDir |
DataDir returns the plugin-specific data directory (guaranteed to exist): |
Defs |
Defs returns config definitions matching the prefix. |
Dump |
Dump returns all config values. |
Get |
Get reads the plugin's own config value (config_ table). |
GetCore |
GetCore reads the core config table. |
GetPlugin |
GetPlugin reads another plugin's config table. |
List |
List returns all keys matching the given prefix. |
ListCore |
ListCore lists core config keys matching the prefix. |
ListPlugin |
ListPlugin lists another plugin's config keys matching the prefix. |
Plugins |
Plugins returns a list of all plugin config namespaces. |
RegisterDef |
RegisterDef registers a config definition for UI display. |
Set |
Set writes a config value to the plugin's own config table. |
SetCore |
SetCore writes to the core config table. |
SetPlugin |
SetPlugin writes to another plugin's config table. |
SettingsAPI.DataDir
DataDir() string
DataDir returns the plugin-specific data directory (guaranteed to exist): /plugin_data/<plugin_name>. Plugins should persist any runtime files (generated images, caches, downloads) here.
settings.go:25
SettingsAPI.Defs
Defs(prefix string) []*ConfigDef
Defs returns config definitions matching the prefix.
settings.go:40
SettingsAPI.Dump
Dump() map[string]interface{}
Dump returns all config values.
settings.go:43
SettingsAPI.Get
Get(key string) (interface{}, error)
Get reads the plugin's own config value (config_ table).
settings.go:5
SettingsAPI.GetCore
GetCore(key string) (interface{}, error)
GetCore reads the core config table.
settings.go:14
SettingsAPI.GetPlugin
GetPlugin(plugin, key string) (interface{}, error)
GetPlugin reads another plugin's config table.
settings.go:28
SettingsAPI.List
List(prefix string) ([]string, error)
List returns all keys matching the given prefix.
settings.go:11
SettingsAPI.ListCore
ListCore(prefix string) ([]string, error)
ListCore lists core config keys matching the prefix.
settings.go:20
SettingsAPI.ListPlugin
ListPlugin(plugin, prefix string) ([]string, error)
ListPlugin lists another plugin's config keys matching the prefix.
settings.go:34
SettingsAPI.Plugins
Plugins() []string
Plugins returns a list of all plugin config namespaces.
settings.go:46
SettingsAPI.RegisterDef
RegisterDef(def ConfigDef)
RegisterDef registers a config definition for UI display.
settings.go:37
SettingsAPI.Set
Set(key string, value interface{}) error
Set writes a config value to the plugin's own config table.
settings.go:8
SettingsAPI.SetCore
SetCore(key string, value interface{}) error
SetCore writes to the core config table.
settings.go:17
SettingsAPI.SetPlugin
SetPlugin(plugin, key string, value interface{}) error
SetPlugin writes to another plugin's config table.
settings.go:31
ConfigDef
type ConfigDef struct { Key string `json:"key"` Default interface{} `json:"default,omitempty"` Type string `json:"type"` DisplayName string …
ConfigDef describes a configuration field for the WebUI.
settings.go:50
PluginSDK.Settings
func (s *PluginSDK) Settings() SettingsAPI
Settings returns the settings API for reading/writing plugin configuration. sett 在 New 时一次性写入且无 setter，故不需要加锁。
示例插件里的真实用法
| 插件 | 位置 | 代码 |
|---|---|---|
a2a |
example/a2a/plugin.go:68 |
s.Settings().RegisterDef(sdk.ConfigDef{ |
acp |
example/acp/plugin.go:63 |
s.Settings().RegisterDef(sdk.ConfigDef{ |
ai_image |
example/ai_image/plugin.go:114 |
s.Settings().RegisterDef(sdk.ConfigDef{ |
bili |
example/bili/plugin.go:67 |
s.Settings().RegisterDef(sdk.ConfigDef{ |
plugin.go:505