chore(i18n): refresh zh-CN translations

This commit is contained in:
openclaw-docs-i18n[bot] 2026-04-23 07:46:10 +00:00
parent 16e249d6c5
commit f8f2d1ab01
3 changed files with 873 additions and 788 deletions

File diff suppressed because it is too large Load Diff

View File

@ -5,61 +5,61 @@ read_when:
summary: 插件清单 + JSON schema 要求(严格配置校验)
title: 插件清单
x-i18n:
generated_at: "2026-04-23T06:24:03Z"
generated_at: "2026-04-23T07:42:11Z"
model: gpt-5.4
provider: openai
source_hash: de71b9d556c2696d3279f202b66d57aa8014e9c89d81e3f453602744120d1675
source_hash: d48810f604aa0c3ff8553528cfa4cb735d1d5e7a15b1bbca6152070d6c8f9cce
source_path: plugins/manifest.md
workflow: 15
---
# 插件清单(`openclaw.plugin.json`
本页仅适用于 **原生 OpenClaw 插件清单**
本页仅介绍 **原生 OpenClaw 插件清单**
关于兼容的 bundle 布局,请参阅 [插件 bundles](/zh-CN/plugins/bundles)。
有关兼容的 bundle 布局,请参阅 [Plugin bundles](/zh-CN/plugins/bundles)。
兼容的 bundle 格式使用不同的清单文件:
- Codex bundle`.codex-plugin/plugin.json`
- Claude bundle`.claude-plugin/plugin.json`,或不使用清单的默认 Claude 组件布局
- Claude bundle`.claude-plugin/plugin.json`,或不带清单文件的默认 Claude 组件布局
- Cursor bundle`.cursor-plugin/plugin.json`
OpenClaw 也会自动检测这些 bundle 布局,但不会依据这里描述`openclaw.plugin.json` schema 对它们进行校验。
OpenClaw 也会自动检测这些 bundle 布局,但不会按照这里介绍`openclaw.plugin.json` schema 对它们进行校验。
对于兼容 bundles,当其布局符合 OpenClaw 运行时预期时OpenClaw 前会读取 bundle 元数据,以及声明的 skill 根目录、Claude 命令根目录、Claude bundle `settings.json` 默认值、Claude bundle LSP 默认值,以及受支持的 hook packs
对于兼容 bundle当其布局符合 OpenClaw 运行时预期时OpenClaw 前会读取 bundle 元数据,以及声明的 skill 根目录、Claude 命令根目录、Claude bundle `settings.json` 默认值、Claude bundle LSP 默认值,以及受支持的 hook pack。
每个原生 OpenClaw 插件 **必须** **插件根目录** 中提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用这个清单在 **不执行插件代码** 的情况下校验配置。缺失或无效的清单会被视为插件错误,并阻止配置校验。
每个原生 OpenClaw 插件**必须**在**插件根目录**中提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用此清单在**不执行插件代码的情况下**校验配置。缺失或无效的清单会被视为插件错误,并阻止配置校验。
请参阅完整的插件系统指南:[插件](/zh-CN/tools/plugin)。
关于原生能力模型和当前的外部兼容性指南,请参阅:
[能力模型](/zh-CN/plugins/architecture#public-capability-model)。
查看完整的插件系统指南:[Plugins](/zh-CN/tools/plugin)。
有关原生能力模型和当前外部兼容性指导,请参阅:
[Capability model](/zh-CN/plugins/architecture#public-capability-model)。
## 这个文件的作用
## 文件的作用
`openclaw.plugin.json` 是 OpenClaw 在加载你的插件代码之前读取的元数据。
用于:
可将其用于:
- 插件标识
- 配置校验
- 无需启动插件运行时即可获的认证和新手引导元数据
- 运行时加载前,控制平面界面可检查的低成本激活提示
- 运行时加载前,设置 / 新手引导界面可检查的低成本设置描述符
- 运行时加载前解析的别名和自动启用元数据
- 运行时加载前自动激活插件的简写模型族归属元数据
- 无需启动插件运行时即可获的认证和新手引导元数据
- 控制平面界面可在运行时加载前检查的轻量激活提示
- 设置/新手引导界面可在运行时加载前检查的轻量设置描述符
- 应在插件运行时加载前解析的别名和自动启用元数据
- 应在插件运行时加载前自动激活插件的简写模型族归属元数据
- 用于内置兼容接线和契约覆盖的静态能力归属快照
- 共享 `openclaw qa` 主机在插件运行时加载前可检查的低成本 QA 运行器元数据
- 无需加载运行时即可合并到目录和校验界面的渠道特定配置元数据
- 共享 `openclaw qa` 主机可在插件运行时加载前检查的轻量 QA 运行器元数据
- 可在不加载运行时的情况下合并到目录和校验界面的渠道专用配置元数据
- 配置 UI 提示
不要用于:
不要将其用于:
- 注册运行时行为
- 声明代码入口点
- npm 安装元数据
这些应放在你的插件代码和 `package.json`
这些内容属于你的插件代码和 `package.json`
## 最小示例
@ -108,19 +108,19 @@ OpenClaw 也会自动检测这些 bundle 布局,但不会依据这里描述的
"provider": "openrouter",
"method": "api-key",
"choiceId": "openrouter-api-key",
"choiceLabel": "OpenRouter API key",
"choiceLabel": "OpenRouter API 密钥",
"groupId": "openrouter",
"groupLabel": "OpenRouter",
"optionKey": "openrouterApiKey",
"cliFlag": "--openrouter-api-key",
"cliOption": "--openrouter-api-key <key>",
"cliDescription": "OpenRouter API key",
"cliDescription": "OpenRouter API 密钥",
"onboardingScopes": ["text-inference"]
}
],
"uiHints": {
"apiKey": {
"label": "API key",
"label": "API 密钥",
"placeholder": "sk-or-v1-...",
"sensitive": true
}
@ -143,61 +143,61 @@ OpenClaw 也会自动检测这些 bundle 布局,但不会依据这里描述的
| ------------------------------------ | -------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | 是 | `string` | 规范的插件 id。这是在 `plugins.entries.<id>` 中使用的 id。 |
| `configSchema` | 是 | `object` | 此插件配置的内联 JSON Schema。 |
| `enabledByDefault` | 否 | `true` | 将内置插件标记为默认启用。省略该字段,或将其设置为任何非 `true` 的值,以保持插件默认禁用。 |
| `enabledByDefault` | 否 | `true` | 将内置插件标记为默认启用。省略此字段,或设置为任何非 `true` 的值,则插件默认保持禁用。 |
| `legacyPluginIds` | 否 | `string[]` | 会规范化为此规范插件 id 的旧版 id。 |
| `autoEnableWhenConfiguredProviders` | 否 | `string[]` | 当认证、配置或模型引用提这些 provider id 时,应自动启用此插件。 |
| `kind` | 否 | `"memory"` \| `"context-engine"` | 声明一个由 `plugins.slots.*` 使用的互斥插件类型。 |
| `autoEnableWhenConfiguredProviders` | 否 | `string[]` | 当认证、配置或模型引用提这些 provider id 时,应自动启用此插件。 |
| `kind` | 否 | `"memory"` \| `"context-engine"` | 声明`plugins.slots.*` 使用的排他性插件类型。 |
| `channels` | 否 | `string[]` | 由此插件拥有的渠道 id。用于设备发现和配置校验。 |
| `providers` | 否 | `string[]` | 由此插件拥有的 provider id。 |
| `modelSupport` | 否 | `object` | 由清单拥有的简写模型族元数据,用于在运行时之前自动加载插件。 |
| `providerEndpoints` | 否 | `object[]` | 由清单拥有的 endpoint host/baseUrl 元数据,用于核心系统必须在 provider 运行时加载前分类的 provider 路由。 |
| `modelSupport` | 否 | `object` | 由清单拥有的简写模型族元数据,用于在运行时之前自动加载插件。 |
| `providerEndpoints` | 否 | `object[]` | 由清单拥有的端点 host/baseUrl 元数据,用于核心在 provider 运行时加载前对 provider 路由进行分类。 |
| `cliBackends` | 否 | `string[]` | 由此插件拥有的 CLI 推理后端 id。用于根据显式配置引用在启动时自动激活。 |
| `syntheticAuthRefs` | 否 | `string[]` | provider 或 CLI 后端引用;在运行时加载前的冷启动模型发现期间,应探测其由插件拥有的 synthetic auth hook。 |
| `nonSecretAuthMarkers` | 否 | `string[]` | 由内置插件拥有的占位 API key 值用于表示非机密的本地、OAuth 或环境凭证状态。 |
| `commandAliases` | 否 | `object[]` | 由此插件拥有的命令名称;在运行时加载前,应产出带有插件感知能力的配置和 CLI 诊断信息。 |
| `providerAuthEnvVars` | 否 | `Record<string, string[]>` | OpenClaw 无需加载插件代码即可检查的低成本 provider 认证环境变量元数据。 |
| `providerAuthAliases` | 否 | `Record<string, string>` | 应复用另一个 provider id 进行认证查找的 provider id例如共享基础 provider API key 和认证配置文件的编码 provider。 |
| `channelEnvVars` | 否 | `Record<string, string[]>` | OpenClaw 无需加载插件代码即可检查的低成本渠道环境变量元数据。将其用于通用启动 / 配置辅助工具应能看到的、由环境变量驱动的渠道设置或认证界面。 |
| `providerAuthChoices` | 否 | `object[]` | 用于新手引导选择器、首选 provider 解析和简单 CLI 标志接线的低成本认证选项元数据。 |
| `activation` | 否 | `object` | 用于 provider、命令、渠道、路由和能力触发加载的低成本激活提示。仅为元数据插件运行时仍然拥有实际行为。 |
| `setup` | 否 | `object` | 设备发现和设置界面无需加载插件运行时即可检查的低成本设置 / 新手引导描述符。 |
| `qaRunners` | 否 | `object[]` | 共享 `openclaw qa` 主机在插件运行时加载前使用的低成本 QA 运行器描述符。 |
| `contracts` | 否 | `object` | 外部认证 hooks、语音、实时转录、实时语音、媒体理解、图像生成、音乐生成、视频生成、网页抓取、网页搜索和工具归属的静态内置能力快照。 |
| `mediaUnderstandingProviderMetadata` | 否 | `Record<string, object>` | 为 `contracts.mediaUnderstandingProviders` 中声明的 provider id 提供的低成本媒体理解默认值。 |
| `channelConfigs` | 否 | `Record<string, object>` | 由清单拥有的渠道配置元数据,在运行时加载前合并到设备发现和校验界面中。 |
| `syntheticAuthRefs` | 否 | `string[]` | 在运行时加载前的冷启动模型发现期间,应探测其由插件拥有的合成认证 hook 的 provider 或 CLI 后端引用。 |
| `nonSecretAuthMarkers` | 否 | `string[]` | 由内置插件拥有的占位 API 密钥值用于表示非机密的本地、OAuth 或环境凭据状态。 |
| `commandAliases` | 否 | `object[]` | 由此插件拥有的命令名称,应在运行时加载前生成带有插件感知能力的配置和 CLI 诊断信息。 |
| `providerAuthEnvVars` | 否 | `Record<string, string[]>` | OpenClaw 可在不加载插件代码的情况下检查的轻量 provider 认证环境变量元数据。 |
| `providerAuthAliases` | 否 | `Record<string, string>` | 应复用另一个 provider id 进行认证查找的 provider id例如共享基础 provider API 密钥和认证配置文件的编码 provider。 |
| `channelEnvVars` | 否 | `Record<string, string[]>` | OpenClaw 可在不加载插件代码的情况下检查的轻量渠道环境变量元数据。将其用于由环境变量驱动的渠道设置或认证界面,以便通用启动/配置辅助工具能够识别。 |
| `providerAuthChoices` | 否 | `object[]` | 用于新手引导选择器、首选 provider 解析和简单 CLI 标志接线的轻量认证选项元数据。 |
| `activation` | 否 | `object` | 面向 provider、命令、渠道、路由和能力触发加载的轻量激活提示。仅是元数据实际行为仍由插件运行时负责。 |
| `setup` | 否 | `object` | 设备发现和设置界面可在不加载插件运行时的情况下检查的轻量设置/新手引导描述符。 |
| `qaRunners` | 否 | `object[]` | 共享 `openclaw qa` 主机在插件运行时加载前使用的轻量 QA 运行器描述符。 |
| `contracts` | 否 | `object` | 面向外部认证 hook、speech、实时转录、实时语音、媒体理解、图像生成、音乐生成、视频生成、web-fetch、Web 搜索和工具归属的静态内置能力快照。 |
| `mediaUnderstandingProviderMetadata` | 否 | `Record<string, object>` | 为 `contracts.mediaUnderstandingProviders` 中声明的 provider id 提供的轻量媒体理解默认值。 |
| `channelConfigs` | 否 | `Record<string, object>` | 由清单拥有的渠道配置元数据,在运行时加载前合并到设备发现和校验界面中。 |
| `skills` | 否 | `string[]` | 要加载的 Skills 目录,相对于插件根目录。 |
| `name` | 否 | `string` | 人类可读的插件名称。 |
| `description` | 否 | `string` | 在插件界面中显示的简短摘要。 |
| `description` | 否 | `string` | 显示在插件界面中的简短摘要。 |
| `version` | 否 | `string` | 仅供参考的插件版本。 |
| `uiHints` | 否 | `Record<string, object>` | 配置字段的 UI 标签、占位符和敏感性提示。 |
## `providerAuthChoices` 参考
每个 `providerAuthChoices` 条目描述一个新手引导或认证选项。
OpenClaw 会在 provider 运行时加载前读取
OpenClaw 会在 provider 运行时加载前读取这些内容
| 字段 | 必填 | 类型 | 含义 |
| --------------------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `provider` | 是 | `string` | 此选项所属的 provider id。 |
| `method` | 是 | `string` | 要分发到的认证方法 id。 |
| `choiceId` | 是 | `string` | 新手引导和 CLI 流程使用的稳定认证选项 id。 |
| `choiceLabel` | 否 | `string` | 面向用户的标签。如省略OpenClaw 会回退到 `choiceId`。 |
| `choiceId` | 是 | `string` | 新手引导和 CLI 流程使用的稳定认证选项 id。 |
| `choiceLabel` | 否 | `string` | 面向用户的标签。如省略OpenClaw 会回退到 `choiceId`。 |
| `choiceHint` | 否 | `string` | 选择器的简短辅助文本。 |
| `assistantPriority` | 否 | `number` | 在由助手驱动的交互式选择器中,值越小排序越靠前。 |
| `assistantVisibility` | 否 | `"visible"` \| `"manual-only"` | 在助手选择器中隐藏该选项,但仍允许手动通过 CLI 选择。 |
| `assistantPriority` | 否 | `number` | 在由助手驱动的交互式选择器中,值越小越靠前。 |
| `assistantVisibility` | 否 | `"visible"` \| `"manual-only"` | 在助手选择器中隐藏此选项,但仍允许通过手动 CLI 进行选择。 |
| `deprecatedChoiceIds` | 否 | `string[]` | 应将用户重定向到此替代选项的旧版选项 id。 |
| `groupId` | 否 | `string` | 用于对相关选项分组的可选组 id。 |
| `groupLabel` | 否 | `string` | 该分组面向用户标签。 |
| `groupId` | 否 | `string` | 用于分组相关选项的可选分组 id。 |
| `groupLabel` | 否 | `string` | 该分组面向用户标签。 |
| `groupHint` | 否 | `string` | 该分组的简短辅助文本。 |
| `optionKey` | 否 | `string` | 用于简单单标志认证流程的内部选项键。 |
| `cliFlag` | 否 | `string` | CLI 标志名,例如 `--openrouter-api-key`。 |
| `cliFlag` | 否 | `string` | CLI 标志名,例如 `--openrouter-api-key`。 |
| `cliOption` | 否 | `string` | 完整的 CLI 选项形式,例如 `--openrouter-api-key <key>`。 |
| `cliDescription` | 否 | `string` | 在 CLI 帮助中使用的描述。 |
| `onboardingScopes` | 否 | `Array<"text-inference" \| "image-generation">` | 此选项应出现在哪些新手引导界面中。如省略,默认值为 `["text-inference"]`。 |
| `cliDescription` | 否 | `string` | CLI 帮助中使用的说明。 |
| `onboardingScopes` | 否 | `Array<"text-inference" \| "image-generation">` | 此选项应出现在哪些新手引导界面中。如省略,默认值为 `["text-inference"]`。 |
## `commandAliases` 参考
当插件拥有一个运行时命令名称,而用户可能误将其放入 `plugins.allow` 或尝试将其作为根 CLI 命令运行时,请使用 `commandAliases`。OpenClaw 使用这些元数据提供诊断信息,而无需导入插件运行时代码。
某个插件拥有一个运行时命令名称,而用户可能会误将其放入 `plugins.allow`,或尝试将其作为根级 CLI 命令运行时,请使用 `commandAliases`。OpenClaw 使用此元数据进行诊断,而无需导入插件运行时代码。
```json
{
@ -214,16 +214,16 @@ OpenClaw 会在 provider 运行时加载前读取它。
| 字段 | 必填 | 类型 | 含义 |
| ------------ | -------- | ----------------- | ----------------------------------------------------------------------- |
| `name` | 是 | `string` | 属于此插件的命令名称。 |
| `kind` | 否 | `"runtime-slash"` | 将该别名标记为聊天斜杠命令,而不是根 CLI 命令。 |
| `cliCommand` | 否 | `string` | 用于 CLI 操作时建议的相关根 CLI 命令(如果存在)。 |
| `kind` | 否 | `"runtime-slash"` | 将该别名标记为聊天斜杠命令,而不是根 CLI 命令。 |
| `cliCommand` | 否 | `string` | 如果存在,用于建议 CLI 操作的相关根 CLI 命令。 |
## `activation` 参考
当插件可以低成本地声明哪些控制平面事件应在后续激活它时,请使用 `activation`
当插件能够以低成本声明哪些控制平面事件应在后续激活它时,请使用 `activation`
## `qaRunners` 参考
当插件在共享`openclaw qa` 根命令下提供一个或多个传输运行器时,请使用 `qaRunners`。保持这些元数据低成本且静态;插件运行时仍通过导出 `qaRunnerCliRegistrations` 的轻量级 `runtime-api.ts` 界面来拥有实际的 CLI 注册。
当插件在共享 `openclaw qa` 根命令下贡献一个或多个传输运行器时,请使用 `qaRunners`。保持这些元数据轻量且静态;插件运行时仍通过导出 `qaRunnerCliRegistrations` 的轻量 `runtime-api.ts` 接口负责实际的 CLI 注册。
```json
{
@ -239,9 +239,10 @@ OpenClaw 会在 provider 运行时加载前读取它。
| 字段 | 必填 | 类型 | 含义 |
| ------------- | -------- | -------- | ------------------------------------------------------------------ |
| `commandName` | 是 | `string` | 挂载在 `openclaw qa` 下的子命令,例如 `matrix`。 |
| `description` | 否 | `string` | 当共享主机需要一个存根命令时使用的回退帮助文本。 |
| `description` | 否 | `string` | 当共享主机需要一个占位命令时使用的回退帮助文本。 |
此块仅为元数据。它不会注册运行时行为,也不会替代 `register(...)`、`setupEntry` 或其他运行时 / 插件入口点。当前使用方将其作为在更广泛的插件加载之前进行缩小范围的提示,因此缺少激活元数据通常只会带来性能损耗;在旧版清单归属回退仍存在时,它不应改变正确性。
此块仅为元数据。它不会注册运行时行为,也不会替代 `register(...)`、`setupEntry` 或其他运行时/插件入口点。
当前使用方将其作为更广泛插件加载前的缩小范围提示,因此缺少激活元数据通常只会带来性能损耗;在旧版清单归属回退机制仍存在时,它不应改变正确性。
```json
{
@ -261,17 +262,17 @@ OpenClaw 会在 provider 运行时加载前读取它。
| `onCommands` | 否 | `string[]` | 应激活此插件的命令 id。 |
| `onChannels` | 否 | `string[]` | 应激活此插件的渠道 id。 |
| `onRoutes` | 否 | `string[]` | 应激活此插件的路由类型。 |
| `onCapabilities` | 否 | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 控制平面激活规划使用的广义能力提示。 |
| `onCapabilities` | 否 | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 控制平面激活规划使用的宽泛能力提示。 |
当前在线使用方:
当前在线使用方:
- 由命令触发的 CLI 规划会回退到旧版的 `commandAliases[].cliCommand``commandAliases[].name`
- 当缺少显式渠道激活元数据时,由渠道触发的设置 / 渠道规划会回退到旧版 `channels[]` 归属
- 当缺少显式 provider 激活元数据时,由 provider 触发的设置 / 运行时规划会回退到旧版的 `providers[]` 和顶层 `cliBackends[]` 归属
- 由渠道触发的设置/渠道规划会在缺少显式渠道激活元数据时,回退到旧版 `channels[]` 归属
- 由 provider 触发的设置/运行时规划会在缺少显式 provider 激活元数据时,回退到旧版的 `providers[]` 和顶层 `cliBackends[]` 归属
## `setup` 参考
当设置和新手引导界面需要在运行时加载前获取由插件拥有的低成本元数据时,请使用 `setup`
当设置和新手引导界面在运行时加载前需要轻量的插件自有元数据时,请使用 `setup`
```json
{
@ -290,32 +291,32 @@ OpenClaw 会在 provider 运行时加载前读取它。
}
```
顶层 `cliBackends` 仍然有效,并继续描述 CLI 推理后端。`setup.cliBackends` 是用于控制平面 / 设置流程的、特定于设置的描述符界面,应保持为仅元数据。
顶层 `cliBackends` 仍然有效,并继续描述 CLI 推理后端。`setup.cliBackends` 是面向控制平面/设置流程的设置专用描述符界面,应保持为纯元数据。
存在 `setup.providers``setup.cliBackends` 时,它们是设置发现过程中优先使用的、描述符优先的查找界面。如果该描述符仅缩小候选插件范围,而设置仍需要更丰富的设置时运行时 hooks请设置 `requiresRuntime: true`,并保留 `setup-api` 作为回退执行路径。
存在时,`setup.providers` 和 `setup.cliBackends` 是设置发现的首选“描述符优先”查找界面。如果该描述符仅用于缩小候选插件范围,而设置仍需要更丰富的设置期运行时 hook请将 `requiresRuntime` 设为 `true`,并保留 `setup-api` 作为回退执行路径。
由于设置查找可能执行由插件拥有的 `setup-api` 代码,规范化后的 `setup.providers[].id``setup.cliBackends[]`在已发现插件之间必须保持唯一。归属不明确时会以保守方式失败,而不是按发现顺序选出一个赢家
由于设置查找可能会执行插件自有的 `setup-api` 代码,规范化后的 `setup.providers[].id``setup.cliBackends[]`必须在所有已发现插件之间保持唯一。若归属不明确,系统会采用失败关闭,而不是按发现顺序选出一个胜者
### `setup.providers` 参考
| 字段 | 必填 | 类型 | 含义 |
| ------------- | -------- | ---------- | ------------------------------------------------------------------------------------ |
| `id` | 是 | `string` | 在设置或新手引导期间公开的 provider id。保持规范化 id 在全局范围内唯一。 |
| `authMethods` | 否 | `string[]` | 此 provider 在无需加载完整运行时的情况下支持的设置 / 认证方法 id。 |
| `envVars` | 否 | `string[]` | 通用设置 / 状态界面可在插件运行时加载前检查的环境变量。 |
| `authMethods` | 否 | `string[]` | 此 provider 在不加载完整运行时的情况下支持的设置/认证方法 id。 |
| `envVars` | 否 | `string[]` | 通用设置/状态界面可在插件运行时加载前检查的环境变量。 |
### `setup` 字段
| 字段 | 必填 | 类型 | 含义 |
| ------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------- |
| `providers` | 否 | `object[]` | 在设置和新手引导期间公开的 provider 设置描述符。 |
| `cliBackends` | 否 | `string[]` | 用于描述符优先设置查找的设置时后端 id。保持规范化 id 在全局范围内唯一。 |
| `cliBackends` | 否 | `string[]` | 用于“描述符优先”设置查找的设置期后端 id。保持规范化 id 在全局范围内唯一。 |
| `configMigrations` | 否 | `string[]` | 由此插件的设置界面拥有的配置迁移 id。 |
| `requiresRuntime` | 否 | `boolean` | 描述符查找之后,设置是否仍需要执行 `setup-api`。 |
| `requiresRuntime` | 否 | `boolean` | 描述符查找之后,设置是否仍需要执行 `setup-api`。 |
## `uiHints` 参考
`uiHints` 是一个从配置字段名到小型渲染提示的映射。
`uiHints` 是一个从配置字段名映射到小型渲染提示的映射
```json
{
@ -337,13 +338,13 @@ OpenClaw 会在 provider 运行时加载前读取它。
| `label` | `string` | 面向用户的字段标签。 |
| `help` | `string` | 简短辅助文本。 |
| `tags` | `string[]` | 可选的 UI 标签。 |
| `advanced` | `boolean` | 将该字段标记为高级。 |
| `sensitive` | `boolean` | 将该字段标记为机密或敏感。 |
| `advanced` | `boolean` | 将该字段标记为高级字段。 |
| `sensitive` | `boolean` | 将该字段标记为机密或敏感。 |
| `placeholder` | `string` | 表单输入的占位文本。 |
## `contracts` 参考
仅当 OpenClaw 无需导入插件运行时即可读取静态能力归属元数据时,才使用 `contracts`
仅当 `contracts` 用于 OpenClaw 可在不导入插件运行时的情况下读取的静态能力归属元数据时,才应使用它
```json
{
@ -369,21 +370,21 @@ OpenClaw 会在 provider 运行时加载前读取它。
| -------------------------------- | ---------- | ----------------------------------------------------------------- |
| `embeddedExtensionFactories` | `string[]` | 内置插件可为其注册工厂的嵌入式运行时 id。 |
| `externalAuthProviders` | `string[]` | 此插件拥有其外部认证配置文件 hook 的 provider id。 |
| `speechProviders` | `string[]` | 此插件拥有的语音 provider id。 |
| `speechProviders` | `string[]` | 此插件拥有的 speech provider id。 |
| `realtimeTranscriptionProviders` | `string[]` | 此插件拥有的实时转录 provider id。 |
| `realtimeVoiceProviders` | `string[]` | 此插件拥有的实时语音 provider id。 |
| `mediaUnderstandingProviders` | `string[]` | 此插件拥有的媒体理解 provider id。 |
| `imageGenerationProviders` | `string[]` | 此插件拥有的图像生成 provider id。 |
| `videoGenerationProviders` | `string[]` | 此插件拥有的视频生成 provider id。 |
| `webFetchProviders` | `string[]` | 此插件拥有的网页抓取 provider id。 |
| `webSearchProviders` | `string[]` | 此插件拥有的网页搜索 provider id。 |
| `tools` | `string[]` | 此插件为内置契约检查所拥有的智能体工具名称。 |
| `webFetchProviders` | `string[]` | 此插件拥有的 Web-fetch provider id。 |
| `webSearchProviders` | `string[]` | 此插件拥有的 Web 搜索 provider id。 |
| `tools` | `string[]` | 此插件拥有、用于内置契约检查的智能体工具名称。 |
实现了 `resolveExternalAuthProfiles` 的 provider 插件应声明 `contracts.externalAuthProviders`。未作此声明的插件仍会通过已弃用的兼容性回退路径运行,但该回退更慢,并将在迁移窗口结束后移除。
实现了 `resolveExternalAuthProfiles` 的 provider 插件应声明 `contracts.externalAuthProviders`。未声明该项的插件仍会通过已弃用的兼容性回退路径运行,但该回退路径更慢,并将在迁移窗口结束后移除。
## `mediaUnderstandingProviderMetadata` 参考
当某个媒体理解 provider 具有默认模型、自动认证回退优先级,或通用核心辅助工具在运行时加载前所需的原生文档支持时,请使用 `mediaUnderstandingProviderMetadata`。其中的键也必须在 `contracts.mediaUnderstandingProviders` 中声明。
当某个媒体理解 provider 具有默认模型、自动认证回退优先级,或通用核心辅助工具在运行时加载前所需的原生文档支持时,请使用 `mediaUnderstandingProviderMetadata`。其键也必须在 `contracts.mediaUnderstandingProviders` 中声明。
```json
{
@ -412,12 +413,12 @@ OpenClaw 会在 provider 运行时加载前读取它。
| ---------------------- | ----------------------------------- | ---------------------------------------------------------------------------- |
| `capabilities` | `("image" \| "audio" \| "video")[]` | 此 provider 提供的媒体能力。 |
| `defaultModels` | `Record<string, string>` | 当配置未指定模型时使用的“能力到模型”默认值。 |
| `autoPriority` | `Record<string, number>` | 用于基于凭证的自动 provider 回退时,数值越小排序越靠前。 |
| `nativeDocumentInputs` | `"pdf"[]` | provider 支持的原生文档输入。 |
| `autoPriority` | `Record<string, number>` | 用于基于凭据的自动 provider 回退时,数字越小越靠前。 |
| `nativeDocumentInputs` | `"pdf"[]` | provider 支持的原生文档输入。 |
## `channelConfigs` 参考
当某个渠道插件在运行时加载前需要低成本配置元数据时,请使用 `channelConfigs`
当某个渠道插件在运行时加载前需要轻量配置元数据时,请使用 `channelConfigs`
```json
{
@ -448,15 +449,15 @@ OpenClaw 会在 provider 运行时加载前读取它。
| 字段 | 类型 | 含义 |
| ------------- | ------------------------ | ----------------------------------------------------------------------------------------- |
| `schema` | `object` | `channels.<id>` 的 JSON Schema。对每个已声明的渠道配置条目来说是必填项。 |
| `uiHints` | `Record<string, object>` | 该渠道配置部分可选 UI 标签 / 占位符 / 敏感性提示。 |
| `schema` | `object` | `channels.<id>` 的 JSON Schema。每个已声明的渠道配置条目都必须提供。 |
| `uiHints` | `Record<string, object>` | 该渠道配置部分可选 UI 标签/占位符/敏感性提示。 |
| `label` | `string` | 当运行时元数据尚未就绪时,合并到选择器和检查界面中的渠道标签。 |
| `description` | `string` | 用于检查和目录界面的简短渠道描述。 |
| `preferOver` | `string[]` | 在选择界面中,此渠道应优先于的旧版或较低优先级插件 id。 |
## `modelSupport` 参考
当 OpenClaw 应在插件运行时加载前,根据简写模型 id `gpt-5.4``claude-sonnet-4.6`推断你的 provider 插件时,请使用 `modelSupport`
当 OpenClaw 应在插件运行时加载前,根据 `gpt-5.4``claude-sonnet-4.6` 之类的简写模型 id 推断你的 provider 插件时,请使用 `modelSupport`
```json
{
@ -469,67 +470,68 @@ OpenClaw 会在 provider 运行时加载前读取它。
OpenClaw 应用以下优先级:
- 显式 `provider/model` 引用使用所属 `providers` 清单元数据
- 显式 `provider/model` 引用使用所属 `providers` 清单元数据
- `modelPatterns` 优先于 `modelPrefixes`
- 如果一个非内置插件和一个内置插件匹配,则非内置插件胜出
- 剩余歧义会被忽略,直到用户或配置指定 provider
- 如果一个非内置插件和一个内置插件同时匹配,则非内置插件胜出
- 剩余歧义会被忽略,直到用户或配置显式指定 provider
字段:
| 字段 | 类型 | 含义 |
| --------------- | ---------- | ------------------------------------------------------------------------------- |
| `modelPrefixes` | `string[]` | 对简写模型 id 使用 `startsWith` 匹配的前缀。 |
| `modelPatterns` | `string[]` | 在移除 profile 后缀后,对简写模型 id 进行匹配的正则表达式源码。 |
| `modelPrefixes` | `string[]` | 使用 `startsWith` 针对简写模型 id 进行匹配的前缀。 |
| `modelPatterns` | `string[]` | 在移除配置文件后缀之后,针对简写模型 id 进行匹配的正则表达式源码。 |
旧版顶层能力键已弃用。使用 `openclaw doctor --fix``speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders` 和 `webSearchProviders` 移动到 `contracts` 下;常规清单加载不再将这些顶层字段视为能力归属。
旧版顶层能力键已弃用。使用 `openclaw doctor --fix``speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders` 和 `webSearchProviders` 移动到 `contracts` 下;常规清单加载不再将这些顶层字段视为能力归属声明
## 清单与 package.json 的区别
## 清单与 `package.json` 的区别
这两个文件承担不同职责:
这两个文件承担不同职责:
| 文件 | 用途 |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `openclaw.plugin.json` | 设备发现、配置校验、认证选项元数据,以及必须在插件代码运行前存在的 UI 提示 |
| `package.json` | npm 元数据、依赖安装,以及用于入口点、安装门控、设置或目录元数据的 `openclaw` 块 |
如果你不确定某段元数据应放在哪里,请使用这条规则:
如果你不确定某段元数据应该放在哪里,请遵循以下规则:
- 如果 OpenClaw 必须在加载插件代码前知道它,就它放在 `openclaw.plugin.json`
- 如果它与打包、入口文件或 npm 安装行为有关,就它放在 `package.json`
- 如果 OpenClaw 必须在加载插件代码前知道它,就它放在 `openclaw.plugin.json`
- 如果它与打包、入口文件或 npm 安装行为有关,就它放在 `package.json`
### 影响设备发现的 `package.json` 字段
### 影响设备发现的 `package.json` 字段
某些运行时前插件元数据有意放在 `package.json``openclaw` 块下,而不是 `openclaw.plugin.json` 中。
某些运行时前插件元数据有意放在 `package.json``openclaw` 块下,而不是 `openclaw.plugin.json` 中。
重要示例:
| 字段 | 含义 |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `openclaw.extensions` | 声明原生插件入口点。必须保持在插件包目录内。 |
| `openclaw.runtimeExtensions` | 声明已安装包的构建后 JavaScript 运行时入口点。必须保持在插件包目录内。 |
| `openclaw.setupEntry` | 仅用于设置的轻量级入口点,在新手引导、延迟渠道启动以及只读渠道状态 / SecretRef 发现期间使用。必须保持在插件包目录内。 |
| `openclaw.runtimeSetupEntry` | 声明已安装包的构建后 JavaScript 设置入口点。必须保持在插件包目录内。 |
| `openclaw.channel` | 低成本渠道目录元数据,例如标签、文档路径、别名和选择文案。 |
| `openclaw.channel.configuredState` | 轻量已配置状态检查器元数据,可在不加载完整渠道运行时的情况下回答“是否已存在仅环境变量驱动的设置?”。 |
| `openclaw.channel.persistedAuthState` | 轻量持久化认证状态检查器元数据,可在不加载完整渠道运行时的情况下回答“是否已有任何账号登录?”。 |
| `openclaw.install.npmSpec` / `openclaw.install.localPath` | 内置插件和外部发布插件的安装 / 更新提示。 |
| `openclaw.install.defaultChoice` | 当存在多个安装来源时的首选安装路径。 |
| `openclaw.install.minHostVersion` | 最低支持的 OpenClaw 主机版本,使用如 `>=2026.3.22` 这样的 semver 下限。 |
| `openclaw.install.expectedIntegrity` | 期的 npm 分发完整性字符串,例如 `sha512-...`;安装和更新流程会据此校验拉取的制品。 |
| `openclaw.install.allowInvalidConfigRecovery` | 当配置无效时,允许一个范围很窄的内置插件重新安装恢复路径。 |
| `openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListen` | 允许在启动期间先加载仅设置用途的渠道界面,再加载完整渠道插件。 |
| `openclaw.runtimeExtensions` | 为已安装包声明构建后的 JavaScript 运行时入口点。必须保持在插件包目录内。 |
| `openclaw.setupEntry` | 在新手引导、延迟渠道启动和只读渠道状态/SecretRef 发现期间使用的轻量仅设置入口点。必须保持在插件包目录内。 |
| `openclaw.runtimeSetupEntry` | 为已安装包声明构建后的 JavaScript 设置入口点。必须保持在插件包目录内。 |
| `openclaw.channel` | 轻量的渠道目录元数据,例如标签、文档路径、别名和选择文案。 |
| `openclaw.channel.configuredState` | 轻量已配置状态检查器元数据,可在不加载完整渠道运行时的情况下回答“是否已存在仅环境变量设置?”。 |
| `openclaw.channel.persistedAuthState` | 轻量持久化认证状态检查器元数据,可在不加载完整渠道运行时的情况下回答“是否已有任何登录状态?”。 |
| `openclaw.install.npmSpec` / `openclaw.install.localPath` | 面向内置插件和外部发布插件的安装/更新提示。 |
| `openclaw.install.defaultChoice` | 当有多个安装来源可用时的首选安装路径。 |
| `openclaw.install.minHostVersion` | 支持的最低 OpenClaw 主机版本,使用类似 `>=2026.3.22` 的 semver 下限。 |
| `openclaw.install.expectedIntegrity` | 期的 npm 分发完整性字符串,例如 `sha512-...`;安装和更新流程会据此校验获取到的制品。 |
| `openclaw.install.allowInvalidConfigRecovery` | 当配置无效时,允许一个受限的内置插件重装恢复路径。 |
| `openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListen` | 允许在启动期间先加载仅设置的渠道界面,再加载完整渠道插件。 |
清单元数据决定了哪些 provider / 渠道 / 设置选项会在运行时加载前出现在新手引导中。`package.json#openclaw.install` 则告诉新手引导:当用户选择这些选项之一时,应如何获取或启用该插件。不要把安装提示移到 `openclaw.plugin.json` 中。
清单元数据决定了在运行时加载前,新手引导中会出现哪些 provider/渠道/设置选项。`package.json#openclaw.install` 则告诉新手引导,当用户选择其中某个选项时,应如何获取或启用该插件。不要将安装提示移到 `openclaw.plugin.json` 中。
`openclaw.install.minHostVersion` 会在安装期间和清单注册表加载期间强制执行。无效值会被拒绝;值如果有效但要求更新版本,则在较旧主机上会跳过该插件。
`openclaw.install.minHostVersion` 会在安装期间和清单注册表加载期间强制执行。无效值会被拒绝;合法但更新的值会让旧主机跳过该插件。
精确的 npm 版本固定已通过 `npmSpec` 提供,例如 `"npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3"`。如果你希望在拉取到的 npm 制品不再匹配已固定版本时,让更新流程以保守方式失败,请将其与 `expectedIntegrity` 搭配使用。交互式新手引导只有在 `npmSpec` 是精确版本且存在 `expectedIntegrity` 时,才会从受信任的目录元数据中提供 npm 安装选项;否则会回退到本地来源或跳过。
精确的 npm 版本固定已经存在于 `npmSpec` 中,例如
`"npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3"`。当你希望如果获取到的 npm 制品不再匹配固定版本时,让更新流程以失败关闭方式终止,请将其与 `expectedIntegrity` 搭配使用。交互式新手引导会提供受信任注册表的 npm spec包括裸包名和 dist-tag。存在 `expectedIntegrity` 时,安装/更新流程会强制校验它;省略时,会记录注册表解析结果,但不带完整性固定。
当状态、渠道列表或 SecretRef 扫描需要在不加载完整运行时的情况下识别已配置账号时,渠道插件应提供 `openclaw.setupEntry`。该设置入口点应暴露渠道元数据,以及适用于设置场景的安全配置、状态和 secrets 适配器网络客户端、Gateway 网关监听器和传输协议运行时应保留在主扩展入口点中。
当状态、渠道列表或 SecretRef 扫描需要在不加载完整运行时的情况下识别已配置账户时,渠道插件应提供 `openclaw.setupEntry`。设置入口点应公开渠道元数据,以及适用于设置阶段的安全配置、状态和 secrets 适配器网络客户端、Gateway 网关监听器和传输运行时应保留在主扩展入口点中。
运行时入口点字段不会覆盖源码入口点字段的包边界检查。例如,`openclaw.runtimeExtensions` 不能让一个越界的 `openclaw.extensions` 路径变得可加载。
`openclaw.install.allowInvalidConfigRecovery`作用范围被有意限制得很窄。它不会让任意损坏的配置变得可安装。当前它仅允许安装流程从特定的陈旧内置插件升级失败中恢复,例如缺失的内置插件路径,或该同一内置插件的陈旧 `channels.<id>` 条目。无关的配置错误仍会阻止安装,并将操作人员引导 `openclaw doctor --fix`
`openclaw.install.allowInvalidConfigRecovery`设计范围是刻意受限的。它不会让任意损坏配置都变得可安装。当前它只允许安装流程从某些特定的过时内置插件升级失败中恢复,例如缺失的内置插件路径,或该同一内置插件对应的过时 `channels.<id>` 条目。无关的配置错误仍会阻止安装,并将操作人员引导 `openclaw doctor --fix`
`openclaw.channel.persistedAuthState` 是一个微型检查器模块的包元数据:
@ -547,9 +549,9 @@ OpenClaw 应用以下优先级:
}
```
当设置、Doctor 或已配置状态流程需要在完整渠道插件加载前执行低成本的“是 / 否”认证探测时,请使用它。目标导出应是一个只读取持久化状态的小函数;不要通过完整渠道运行时 barrel 转发它。
当设置、Doctor 或已配置状态流程需要在完整渠道插件加载前进行一个轻量的“是/否”认证探测时,请使用它。目标导出应是一个只读取持久化状态的小函数;不要通过完整渠道运行时 barrel 转发它。
`openclaw.channel.configuredState`低成本、仅环境变量的已配置检查采用相同结构:
`openclaw.channel.configuredState`轻量的仅环境变量已配置检查使用相同结构:
```json
{
@ -565,54 +567,55 @@ OpenClaw 应用以下优先级:
}
```
当某个渠道可以从环境变量或其他微小的非运行时输入中回答已配置状态时,请使用它。如果检查需要完整配置解析或真实的渠道运行时,请将该逻辑保留在插件 `config.hasConfiguredState` hook 中。
当某个渠道能够通过环境变量或其他轻量级非运行时输入回答已配置状态时,请使用它。如果该检查需要完整配置解析或真实渠道运行时,请改为将该逻辑保留在插件 `config.hasConfiguredState` hook 中。
## 设备发现优先级(重复插件 id
OpenClaw 会从多个根位置发现插件(内置、全局安装、工作区、配置中显式选择的路径)。如果两个发现结果共享同一个 `id`,则只保留 **优先级最高** 的清单;较低优先级的重复项会被丢弃,而不是与其并行加载。
OpenClaw 会从多个根位置发现插件(内置、全局安装、工作区、配置中显式选择的路径)。如果两次发现共享同一个 `id`,则只保留**优先级最高**的清单;较低优先级的重复项会被丢弃,而不是与其并行加载。
优先级从高到低如下:
1. **配置选** —— 在 `plugins.entries.<id>` 中显式固定的路径
2. **内置** —— 随 OpenClaw 一发布的插件
1. **配置选** —— 在 `plugins.entries.<id>` 中显式固定的路径
2. **内置** —— 随 OpenClaw 一发布的插件
3. **全局安装** —— 安装到全局 OpenClaw 插件根目录中的插件
4. **工作区** —— 相对于当前工作区发现的插件
影响:
- 工作区中某个内置插件的 fork 或陈旧副本不会遮蔽内置构建版本
- 若要真正用本地插件覆盖内置插件,请通过 `plugins.entries.<id>` 固定它,使其凭借优先级胜出,而不要依赖工作区发现。
- 位于工作区中的某个内置插件分叉版本或过时副本,不会遮蔽内置构建
- 如果你确实要用本地插件覆盖内置插件,请通过 `plugins.entries.<id>` 固定它,以便它凭借优先级获胜,而不是依赖工作区发现。
- 被丢弃的重复项会被记录日志,以便 Doctor 和启动诊断能够指向被舍弃的副本。
## JSON Schema 要求
- **每个插件都必须提供一个 JSON Schema**,即使它不接受任何配置。
- 可以接受空 schema例如 `{ "type": "object", "additionalProperties": false }`)。
- schema 会在配置读取 / 写入时校验,而不是在运行时校验。
- 空 schema 也是可以接受的(例如 `{ "type": "object", "additionalProperties": false }`)。
- Schema 会在配置读取/写入时校验,而不是在运行时校验。
## 校验行为
- 未知的 `channels.*`**错误**,除非该渠道 id 由某个插件清单声明。
- `plugins.entries.<id>`、`plugins.allow`、`plugins.deny` 和 `plugins.slots.*` 必须引用 **可发现** 的插件 id。未知 id 属于 **错误**
- 如果某个插件已安装,但其清单或 schema 损坏或缺失,校验会失败,Doctor 会报告该插件错误。
- 如果插件配置存在,但插件 **已禁用**,则会保留该配置,并在 Doctor + 日志中显示 **警告**
- 未知的 `channels.*`会被视为**错误**,除非该渠道 id 已由插件清单声明。
- `plugins.entries.<id>`、`plugins.allow`、`plugins.deny` 和 `plugins.slots.*` 必须引用**可发现的**插件 id。未知 id 会被视为**错误**
- 如果某个插件已安装,但其清单或 schema 损坏或缺失,校验会失败Doctor 会报告该插件错误。
- 如果插件配置存在,但插件处于**禁用**状态,则配置会被保留,并在 Doctor + 日志中显示**警告**
完整的 `plugins.*` schema 请参阅 [配置参考](/zh-CN/gateway/configuration)。
完整的 `plugins.*` schema,请参阅[配置参考](/zh-CN/gateway/configuration)。
## 说明
- 对于原生 OpenClaw 插件,清单是 **必需的**,包括本地文件系统加载的插件。
- **原生 OpenClaw 插件必须提供清单**,包括本地文件系统加载的插件。
- 运行时仍会单独加载插件模块;清单仅用于设备发现 + 校验。
- 原生清单使用 JSON5 解析,因此允许注释、尾随逗号和未加引号的键,只要最终值仍然是一个对象即可。
- 清单加载器只会读取文档中列出的清单字段。避免在这里添加自定义顶层键。
- `providerAuthEnvVars` 是用于认证探测、环境变量标记校验以及类似 provider 认证界面的低成本元数据路径;这些场景不应只是为了检查环境变量名称而启动插件运行时。
- `providerAuthAliases` 允许 provider 变体复用另一个 provider 的认证环境变量、认证配置文件、基于配置的认证以及 API key 新手引导选项,而无需在核心中硬编码这种关系。
- `providerEndpoints` 允许 provider 插件拥有简单 endpoint host/baseUrl 匹配元数据。仅将其用于核心已支持的 endpoint 类别;插件仍然拥有运行时行为。
- `syntheticAuthRefs` 是用于 provider 拥有的 synthetic auth hooks 的低成本元数据路径;这些 hooks 必须在运行时注册表存在之前就对冷启动模型发现可见。只列出其运行时 provider 或 CLI 后端实际实现了 `resolveSyntheticAuth` 的引用。
- `nonSecretAuthMarkers` 是用于内置插件拥有的占位 API key 的低成本元数据路径例如本地、OAuth 或环境凭证标记。核心系统会将这些值视为非机密,用于认证显示和 secret 审计,而无需硬编码所属 provider。
- `channelEnvVars` 是 shell 环境变量回退、设置提示和类似渠道界面的低成本元数据路径这些场景不应只是为了检查环境变量名称而启动插件运行时。环境变量名称只是元数据本身并不触发激活状态、审计、cron 投递校验和其他只读界面在将某个环境变量视为已配置渠道之前,仍会应用插件信任和有效激活策略。
- `providerAuthChoices` 是用于认证选项选择器、`--auth-choice` 解析、首选 provider 映射和简单新手引导 CLI 标志注册的低成本元数据路径,会在 provider 运行时加载前生效。关于需要 provider 代码的运行时向导元数据,请参阅 [Provider 运行时 hooks](/zh-CN/plugins/architecture#provider-runtime-hooks)。
- 互斥插件类型通过 `plugins.slots.*` 进行选择。
- 原生清单使用 JSON5 解析,因此只要最终值仍然是一个对象,就接受注释、尾随逗号和未加引号的键。
- 清单加载器只会读取文档中说明的清单字段。避免在这里添加自定义顶层键。
- `providerAuthEnvVars` 是认证探测、环境变量标记校验以及类似 provider 认证界面的轻量元数据路径,这些场景不应仅为检查环境变量名称就启动插件运行时。
- `providerAuthAliases` 允许 provider 变体复用另一个 provider 的认证环境变量、认证配置文件、基于配置的认证和 API 密钥新手引导选项,而无需在核心中硬编码这种关系。
- `providerEndpoints` 允许 provider 插件拥有简单的端点 host/baseUrl 匹配元数据。仅将其用于核心已支持的端点类别;运行时行为仍由插件负责。
- `syntheticAuthRefs` 是 provider 自有合成认证 hook 的轻量元数据路径,这些 hook 必须在运行时注册表存在之前就对冷启动模型发现可见。只列出其运行时 provider 或 CLI 后端实际实现了 `resolveSyntheticAuth` 的引用。
- `nonSecretAuthMarkers` 是内置插件自有占位 API 密钥例如本地、OAuth 或环境凭据标记)的轻量元数据路径。核心会将这些值视为非机密,以用于认证展示和 secret 审计,而无需硬编码其所属 provider。
- `channelEnvVars` 是 shell 环境变量回退、设置提示和类似渠道界面的轻量元数据路径这些场景不应仅为检查环境变量名称就启动插件运行时。环境变量名称只是元数据本身并不会触发激活状态、审计、cron 投递校验和其他只读界面在将某个环境变量视为已配置渠道之前,仍会应用插件信任和生效激活策略。
- `providerAuthChoices` 是认证选项选择器、`--auth-choice` 解析、首选 provider 映射,以及 provider 运行时加载前简单新手引导 CLI 标志注册的轻量元数据路径。对于需要 provider 代码的运行时向导元数据,请参阅
[Provider runtime hooks](/zh-CN/plugins/architecture#provider-runtime-hooks)。
- 排他性插件类型通过 `plugins.slots.*` 选择。
- `kind: "memory"``plugins.slots.memory` 选择。
- `kind: "context-engine"``plugins.slots.contextEngine` 选择(默认:内置 `legacy`)。
- 当插件不需要时,可以省略 `channels`、`providers`、`cliBackends` 和 `skills`
@ -621,6 +624,6 @@ OpenClaw 会从多个根位置发现插件(内置、全局安装、工作区
## 相关内容
- [构建插件](/zh-CN/plugins/building-plugins) — 插件入门指南
- [插件架构](/zh-CN/plugins/architecture) —— 内部架构
- [SDK 概览](/zh-CN/plugins/sdk-overview) —— 插件 SDK 参考
- [Building Plugins](/zh-CN/plugins/building-plugins) — 插件入门
- [Plugin Architecture](/zh-CN/plugins/architecture) — 内部架构
- [SDK Overview](/zh-CN/plugins/sdk-overview) — 插件 SDK 参考

View File

@ -1,26 +1,26 @@
---
read_when:
- 你正在为一个插件添加设置向导
- 你需要`setup-entry.ts``index.ts` 的区别
- 你正在定义插件配置 schema `package.json` 中的 OpenClaw 元数据
- 你需要`setup-entry.ts``index.ts` 的区别
- 你正在定义插件配置模式`package.json` 中的 OpenClaw 元数据
sidebarTitle: Setup and Config
summary: 设置向导、`setup-entry.ts`、配置 schema,以及 `package.json` 元数据
summary: 设置向导、`setup-entry.ts`、配置模式,以及 `package.json` 元数据
title: 插件设置和配置
x-i18n:
generated_at: "2026-04-23T05:14:54Z"
generated_at: "2026-04-23T07:42:11Z"
model: gpt-5.4
provider: openai
source_hash: ccdafb9a562353a7851fcd47bbc382961a449f5d645362c800f64c60579ce7b2
source_hash: 110cf9aa1bfaeb286d38963cfba2006502e853dd603a126d1c179cbc9b60aea1
source_path: plugins/sdk-setup.md
workflow: 15
---
# 插件设置和配置
关于插件打包(`package.json` 元数据)、清单(`openclaw.plugin.json`)、设置入口和配置 schema 的参考。
关于插件打包(`package.json` 元数据)、清单(`openclaw.plugin.json`)、设置入口和配置模式的参考。
<Tip>
**想看操作演练?** 操作指南会结合上下文讲解打包流程
**想看操作演练?** 操作指南会在具体上下文中介绍打包
[渠道插件](/zh-CN/plugins/sdk-channel-plugins#step-1-package-and-manifest) 和
[提供商插件](/zh-CN/plugins/sdk-provider-plugins#step-1-package-and-manifest)。
</Tip>
@ -42,7 +42,7 @@ x-i18n:
"channel": {
"id": "my-channel",
"label": "My Channel",
"blurb": "渠道的简短描述。"
"blurb": "Short description of the channel."
}
}
}
@ -69,44 +69,46 @@ x-i18n:
}
```
如果你要在 ClawHub 上对外发布插件,则这些 `compat``build` 字段是必需的。规范的发布片段位于 `docs/snippets/plugin-publish/` 中。
如果你要在 ClawHub 上对外发布插件,那么这些 `compat``build`
字段是必需的。规范的发布代码片段位于
`docs/snippets/plugin-publish/`
### `openclaw` 字段
| 字段 | 类型 | 描述 |
| ------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------- |
| `extensions` | `string[]` | 入口点文件(相对于包根目录) |
| `setupEntry` | `string` | 仅用于设置的轻量入口(可选) |
| `channel` | `object` | 用于设置、选择器、快速开始和状态界面的渠道目录元数据 |
| `providers` | `string[]` | 由该插件注册的提供商 id |
| `install` | `object` | 安装提示:`npmSpec`、`localPath`、`defaultChoice`、`minHostVersion`、`expectedIntegrity`、`allowInvalidConfigRecovery` |
| `startup` | `object` | 启动行为标志 |
| 字段 | 类型 | 说明 |
| ------------ | ---------- | ---------------------------------------------------------------------------------------- |
| `extensions` | `string[]` | 入口点文件(相对于包根目录) |
| `setupEntry` | `string` | 仅用于设置的轻量入口(可选) |
| `channel` | `object` | 用于设置、选择器、快速开始和状态界面的渠道目录元数据 |
| `providers` | `string[]` | 由此插件注册的提供商 id |
| `install` | `object` | 安装提示:`npmSpec`、`localPath`、`defaultChoice`、`minHostVersion`、`expectedIntegrity`、`allowInvalidConfigRecovery` |
| `startup` | `object` | 启动行为标志 |
### `openclaw.channel`
`openclaw.channel` 是低成本的包元数据,用于在运行时加载前支持渠道发现和设置界面
`openclaw.channel` 是低成本的包元数据,用于在运行时加载之前完成渠道发现和设置界面展示
| 字段 | 类型 | 含义 |
| -------------------------------------- | ---------- | ------------------------------------------------- |
| `id` | `string` | 规范的渠道 id。 |
| `label` | `string` | 主要渠道标签。 |
| `selectionLabel` | `string` | 当需要与 `label` 不同时,在选择器 / 设置中显示的标签。 |
| `detailLabel` | `string` | 用于更丰富的渠道目录和状态界面的次级详情标签。 |
| `docsPath` | `string` | 用于设置和选择链接的文档路径。 |
| `docsLabel` | `string` | 当文档链接标签需要与渠道 id 不同时使用的覆盖标签。 |
| `blurb` | `string` | 简短的新手引导 / 目录描述。 |
| `order` | `number` | 在渠道目录中的排序顺序。 |
| `aliases` | `string[]` | 用于渠道选择的额外查找别名。 |
| `preferOver` | `string[]` | 该渠道应优先于的低优先级插件 / 渠道 id。 |
| `systemImage` | `string` | 用于渠道 UI 目录的可选图标 / system-image 名称。 |
| `selectionDocsPrefix` | `string` | 在选择界面中文档链接前显示的前缀文本。 |
| `selectionDocsOmitLabel` | `boolean` | 在选择文案中直接显示文档路径,而不是带标签的文档链接。 |
| `selectionExtras` | `string[]` | 附加在选择文案中的额外短文本。 |
| `markdownCapable` | `boolean` | 将该渠道标记为支持 Markdown用于出站格式决策。 |
| `exposure` | `object` | 渠道在设置、已配置列表和文档界面中的可见性控制。 |
| `quickstartAllowFrom` | `boolean` | 让该渠道加入标准快速开始 `allowFrom` 设置流程。 |
| `forceAccountBinding` | `boolean` | 即使只存在一个账户,也要求显式账户绑定。 |
| `preferSessionLookupForAnnounceTarget` | `boolean` | 为该渠道解析公告目标时,优先使用会话查找。 |
| 字段 | 类型 | 含义 |
| -------------------------------------- | ---------- | ------------------------------------------------------------ |
| `id` | `string` | 规范的渠道 id。 |
| `label` | `string` | 渠道标签。 |
| `selectionLabel` | `string` | 当需要与 `label` 不同时,在选择器/设置中使用的标签。 |
| `detailLabel` | `string` | 用于更丰富的渠道目录和状态界面的次级详情标签。 |
| `docsPath` | `string` | 用于设置和选择链接的文档路径。 |
| `docsLabel` | `string` | 当文档链接标签需要与渠道 id 不同时使用的覆盖标签。 |
| `blurb` | `string` | 简短的新手引导/目录描述。 |
| `order` | `number` | 在渠道目录中的排序顺序。 |
| `aliases` | `string[]` | 渠道选择的额外查找别名。 |
| `preferOver` | `string[]` | 此渠道应优先于的低优先级插件/渠道 id。 |
| `systemImage` | `string` | 渠道 UI 目录中可选的图标/system-image 名称。 |
| `selectionDocsPrefix` | `string` | 在选择界面中文档链接前显示的前缀文本。 |
| `selectionDocsOmitLabel` | `boolean` | 在选择文案中直接显示文档路径,而不是带标签的文档链接。 |
| `selectionExtras` | `string[]` | 附加在选择文案中的额外短文本。 |
| `markdownCapable` | `boolean` | 将该渠道标记为支持 Markdown用于出站格式决策。 |
| `exposure` | `object` | 用于设置、已配置列表和文档界面的渠道可见性控制。 |
| `quickstartAllowFrom` | `boolean` | 允许该渠道接入标准快速开始 `allowFrom` 设置流程。 |
| `forceAccountBinding` | `boolean` | 即使只存在一个账号,也要求显式账号绑定。 |
| `preferSessionLookupForAnnounceTarget` | `boolean` | 为该渠道解析公告目标时,优先使用会话查找。 |
示例:
@ -120,11 +122,11 @@ x-i18n:
"detailLabel": "My Channel Bot",
"docsPath": "/channels/my-channel",
"docsLabel": "my-channel",
"blurb": "基于 Webhook 的自托管聊天集成。",
"blurb": "Webhook-based self-hosted chat integration.",
"order": 80,
"aliases": ["mc"],
"preferOver": ["my-channel-legacy"],
"selectionDocsPrefix": "指南:",
"selectionDocsPrefix": "Guide:",
"selectionExtras": ["Markdown"],
"markdownCapable": true,
"exposure": {
@ -140,11 +142,12 @@ x-i18n:
`exposure` 支持:
- `configured`:在已配置 / 状态类列表界面中包含该渠道
- `setup`:在交互式设置 / 配置选择器中包含该渠道
- `docs`:将该渠道标记为在文档 / 导航界面中面向公开展示
- `configured`:在已配置/状态类列表界面中包含该渠道
- `setup`:在交互式设置/配置选择器中包含该渠道
- `docs`:将该渠道标记为在文档/导航界面中对外可见
`showConfigured``showInSetup` 仍然作为旧版别名受到支持。请优先使用 `exposure`
`showConfigured``showInSetup` 仍然作为旧版别名受支持。推荐优先使用
`exposure`
### `openclaw.install`
@ -152,18 +155,25 @@ x-i18n:
| 字段 | 类型 | 含义 |
| ---------------------------- | -------------------- | -------------------------------------------------------------------------------- |
| `npmSpec` | `string` | 用于安装 / 更新流程的规范 npm spec。 |
| `npmSpec` | `string` | 用于安装/更新流程的规范 npm spec。 |
| `localPath` | `string` | 本地开发或内置安装路径。 |
| `defaultChoice` | `"npm"` \| `"local"` | 当两者都可用时的首选安装来源。 |
| `minHostVersion` | `string` | 支持的最低 OpenClaw 版本,格式为 `>=x.y.z`。 |
| `defaultChoice` | `"npm"` \| `"local"` | 当两者都可用时,首选的安装来源。 |
| `minHostVersion` | `string` | 最低支持的 OpenClaw 版本,格式为 `>=x.y.z`。 |
| `expectedIntegrity` | `string` | 预期的 npm dist 完整性字符串,通常为 `sha512-...`,用于固定版本安装。 |
| `allowInvalidConfigRecovery` | `boolean` | 允许内置插件重装流程从特定的过期配置失败中恢复。 |
| `allowInvalidConfigRecovery` | `boolean` | 允许内置插件的重新安装流程从特定的陈旧配置失败中恢复。 |
交互式新手引导也会将 `openclaw.install` 用于按需安装界面。如果你的插件在运行时加载前就暴露提供商认证选项,或暴露渠道设置 / 目录元数据,则新手引导可以显示该选项、提示用户选择 npm 还是本地安装、安装或启用插件然后继续执行所选流程。npm 新手引导选项要求可信的目录元数据,其中必须包含精确版本的 `npmSpec``expectedIntegrity`;未固定版本的包名和 dist-tag 不会用于自动新手引导安装。请将“显示什么”的元数据保留在 `openclaw.plugin.json` 中,将“如何安装”的元数据保留在 `package.json` 中。
交互式新手引导也会使用 `openclaw.install` 来支持按需安装界面。
如果你的插件在运行时加载之前就暴露提供商认证选项,或提供渠道设置/目录元数据,
新手引导就可以展示这些选项,提示选择 npm 或本地安装,安装或启用插件,
然后继续所选流程。npm 新手引导选项要求使用带有注册表 `npmSpec` 的可信目录元数据;
精确版本和 `expectedIntegrity` 是可选的固定项。如果存在
`expectedIntegrity`,安装/更新流程会强制校验它。请将“显示什么”的元数据放在
`openclaw.plugin.json` 中,将“如何安装它”的元数据放在 `package.json` 中。
如果设置了 `minHostVersion`,则安装和清单注册表加载都会强制执行它。较旧的宿主会跳过该插件;无效的版本字符串会被拒绝。
如果设置了 `minHostVersion`,安装和清单注册表加载都会强制执行它。
较旧的宿主会跳过该插件;无效的版本字符串会被拒绝。
对于固定版本的 npm 安装,请在 `npmSpec` 中保留精确版本,并添加预期的制品完整性:
对于固定版本的 npm 安装,请在 `npmSpec` 中保留精确版本,并添加预期的制品完整性
```json
{
@ -177,7 +187,11 @@ x-i18n:
}
```
`allowInvalidConfigRecovery` 并不是对损坏配置的一般性绕过。它仅用于狭窄范围内的内置插件恢复,以便重装 / 设置可以修复已知的升级遗留问题,例如缺失的内置插件路径,或同一插件对应的过期 `channels.<id>` 条目。如果配置因无关原因损坏,安装仍会默认拒绝,并提示操作者运行 `openclaw doctor --fix`
`allowInvalidConfigRecovery` 并不是针对损坏配置的通用绕过方式。
它仅用于狭义的内置插件恢复场景,以便重新安装/设置可以修复已知的升级遗留问题,
例如缺失的内置插件路径,或该插件对应的过期 `channels.<id>` 条目。
如果配置因无关原因损坏,安装仍会以安全关闭方式失败,并提示操作员运行
`openclaw doctor --fix`
### 延迟完整加载
@ -195,31 +209,37 @@ x-i18n:
}
```
启用后在监听前的启动阶段OpenClaw 即使对已经配置的渠道也只会加载 `setupEntry`。完整入口会在 Gateway 网关开始监听后再加载。
启用后OpenClaw 在监听前的启动阶段只会加载 `setupEntry`
即使对于已经配置好的渠道也是如此。完整入口会在 Gateway 网关开始监听后再加载。
<Warning>
只有在你的 `setupEntry` 已经注册了 Gateway 网关在开始监听前所需的一切内容时才应启用延迟加载渠道注册、HTTP 路由、Gateway 网关方法)。如果完整入口拥有必需的启动能力,请保持默认行为。
只有当你的 `setupEntry` 在 Gateway 网关开始监听前已经注册了所有必需内容时,
才应启用延迟加载渠道注册、HTTP 路由、Gateway 网关方法)。
如果完整入口负责必需的启动能力,请保持默认行为。
</Warning>
如果你的设置 / 完整入口会注册 Gateway 网关 RPC 方法,请保持使用插件专属前缀。保留的核心管理命名空间(`config.*`、`exec.approvals.*`、`wizard.*`、`update.*`)仍归核心所有,并始终解析到 `operator.admin`
如果你的设置/完整入口会注册 Gateway 网关 RPC 方法,请把它们放在插件专用前缀下。
保留的核心管理命名空间(`config.*`、
`exec.approvals.*`、`wizard.*`、`update.*`)仍由核心拥有,
并始终解析到 `operator.admin`
## 插件清单
每个原生插件都必须在包根目录中提供一个 `openclaw.plugin.json`
OpenClaw 会用它在不执行插件代码的情况下验证配置。
OpenClaw 会使用它在不执行插件代码的情况下验证配置。
```json
{
"id": "my-plugin",
"name": "My Plugin",
"description": "为 OpenClaw 增加 My Plugin 功能",
"description": "Adds My Plugin capabilities to OpenClaw",
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {
"webhookSecret": {
"type": "string",
"description": "Webhook 验证密钥"
"description": "Webhook verification secret"
}
}
}
@ -241,7 +261,7 @@ OpenClaw 会用它在不执行插件代码的情况下验证配置。
}
```
即使插件没有任何配置,也必须提供一个 schema。空 schema 是有效的:
即使插件没有任何配置,也必须提供一个模式。空模式也是有效的:
```json
{
@ -253,22 +273,24 @@ OpenClaw 会用它在不执行插件代码的情况下验证配置。
}
```
完整的 schema 参考请参阅 [插件清单](/zh-CN/plugins/manifest)。
完整模式参考请见 [插件清单](/zh-CN/plugins/manifest)。
## ClawHub 发布
对于插件包,请使用针对包的 ClawHub 命令:
对于插件包,请使用面向包的 ClawHub 专用命令:
```bash
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
```
旧的仅限 Skills 的发布别名用于 Skills。插件包应始终使用 `clawhub package publish`
旧版仅限 Skills 的发布别名只用于 Skills。插件包应始终使用
`clawhub package publish`
## 设置入口
`setup-entry.ts` 文件是 `index.ts` 的轻量替代方案,当 OpenClaw 只需要设置界面时(新手引导、配置修复、已禁用渠道检查),会加载它。
`setup-entry.ts` 文件是 `index.ts` 的轻量替代方案,
当 OpenClaw 只需要设置界面时(新手引导、配置修复、已禁用渠道检查),就会加载它。
```typescript
// setup-entry.ts
@ -278,66 +300,74 @@ import { myChannelPlugin } from "./src/channel.js";
export default defineSetupPluginEntry(myChannelPlugin);
```
可以避免在设置流程中加载沉重的运行时代码加密库、CLI 注册、后台服务)。
样可以避免在设置流程中加载重量级运行时代码加密库、CLI 注册、后台服务)。
对于将设置安全导出保存在 sidecar 模块中的内置工作区渠道,可以使用
对于那些将设置安全导出保存在辅助模块中的内置工作区渠道,可以使用
`openclaw/plugin-sdk/channel-entry-contract` 中的
`defineBundledChannelSetupEntry(...)`,而不是
`defineSetupPluginEntry(...)`。该内置契约还支持可选的 `runtime` 导出,以便让设置时的运行时接线保持轻量且明确。
`defineSetupPluginEntry(...)`。该内置契约还支持可选的 `runtime` 导出,
从而让设置时的运行时接线保持轻量且明确。
**OpenClaw 何时使用 `setupEntry` 而不是完整入口:**
**OpenClaw 在以下情况下会使用 `setupEntry` 而不是完整入口:**
- 渠道已禁用,但需要设置 / 新手引导界面
- 渠道已禁用,但需要设置/新手引导界面
- 渠道已启用,但尚未配置
- 已启用延迟加载(`deferConfiguredChannelFullLoadUntilAfterListen`
**`setupEntry` 必须注册的内容:**
- 渠道插件对象(通过 `defineSetupPluginEntry`
- 任何在 Gateway 网关开始监听前所需的 HTTP 路由
- 启动期间需的任何 Gateway 网关方法
- Gateway 网关监听前所需的任何 HTTP 路由
- 启动期间需的任何 Gateway 网关方法
这些启动期 Gateway 网关方法仍应避免使用保留的核心管理命名空间,例如 `config.*``update.*`
这些启动期 Gateway 网关方法仍应避免使用保留的核心管理命名空间,
例如 `config.*``update.*`
**`setupEntry` 不应包含的内容:**
- CLI 注册
- 后台服务
- 沉重的运行时导入(加密库、SDK
- 重量级运行时导入(加密、SDK
- 仅在启动后才需要的 Gateway 网关方法
### 精简的设置辅助导入
### 狭义设置辅助导入
对于仅设置的热路径,当你只需要部分设置功能时,应优先使用更精简的设置辅助接缝,而不是更宽泛的 `plugin-sdk/setup` 总入口:
对于仅限设置的热路径,如果你只需要部分设置能力,优先使用狭义的设置辅助接缝,
而不是更宽泛的 `plugin-sdk/setup` 聚合入口:
| 导入路径 | 适用场景 | 关键导出 |
| ---------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugin-sdk/setup-runtime` | 在 `setupEntry` / 延迟渠道启动期间仍可用的设置时运行时辅助工具 | `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` |
| `plugin-sdk/setup-adapter-runtime` | 识别环境的账户设置适配器 | `createEnvPatchedAccountSetupAdapter` |
| `plugin-sdk/setup-tools` | 设置 / 安装 CLI / 归档 / 文档辅助工具 | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
| 导入路径 | 适用场景 | 关键导出 |
| ---------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugin-sdk/setup-runtime` | 在 `setupEntry` / 延迟渠道启动中仍可用的设置期运行时辅助工具 | `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` |
| `plugin-sdk/setup-adapter-runtime` | 感知环境的账号设置适配器 | `createEnvPatchedAccountSetupAdapter` |
| `plugin-sdk/setup-tools` | 设置/安装 CLI/归档/文档辅助工具 | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
当你需要完整的共享设置工具箱时,请使用更宽泛的 `plugin-sdk/setup` 接缝,其中包括配置补丁辅助工具,例如
当你需要完整的共享设置工具箱时,请使用更宽泛的
`plugin-sdk/setup` 接缝,其中包括配置补丁辅助工具,例如
`moveSingleAccountChannelSectionToDefaultAccount(...)`
这些设置补丁适配器在导入时仍然对热路径安全。它们对内置单账户提升契约面的查找是惰性的,因此导入
`plugin-sdk/setup-runtime` 不会在适配器真正使用前急切加载内置契约面发现逻辑。
这些设置补丁适配器在导入时仍可安全用于热路径。它们针对内置单账号提升的契约表面查找是惰性的,
因此导入 `plugin-sdk/setup-runtime` 不会在适配器真正使用前急切加载内置契约面发现逻辑。
### 渠道自有的单账提升
### 渠道自有的单账提升
当渠道从单账户顶层配置升级到
`channels.<id>.accounts.*` 时,默认的共享行为会把提升后的账户作用域值移入 `accounts.default`
当一个渠道从单账号顶层配置升级到
`channels.<id>.accounts.*` 时,默认的共享行为是将被提升的账号级值移动到
`accounts.default` 中。
内置渠道可以通过其设置契约面收窄或覆盖这一提升行为:
内置渠道可以通过其设置契约面收窄或覆盖这一提升行为:
- `singleAccountKeysToMove`:应移入提升后账户的额外顶层键
- `namedAccountPromotionKeys`:如果已存在具名账户,则仅将这些键移入提升后的账户;共享的 policy / delivery 键保留在渠道根级别
- `resolveSingleAccountPromotionTarget(...)`:选择由哪个现有账户接收提升后的值
- `singleAccountKeysToMove`:应移动到被提升账号中的额外顶层键
- `namedAccountPromotionKeys`:当已存在命名账号时,只有这些键会移动到被提升账号中;
共享的策略/投递键会保留在渠道根级
- `resolveSingleAccountPromotionTarget(...)`:选择哪个现有账号接收被提升的值
Matrix 是当前的内置示例。如果恰好已经存在一个具名 Matrix 账户,或者如果 `defaultAccount` 指向现有的非规范键名(例如 `Ops`),那么提升会保留该账户,而不是创建新的 `accounts.default` 条目。
Matrix 是当前的内置示例。如果恰好已存在一个命名的 Matrix 账号,
或者如果 `defaultAccount` 指向一个现有的非规范键(例如 `Ops`
提升过程会保留该账号,而不是新建一个 `accounts.default` 条目。
## 配置 schema
## 配置模式
插件配置会根据你的清单中的 JSON Schema 进行验证。用户通过以下方式配置插件:
插件配置会根据你在清单中定义的 JSON Schema 进行验证。用户通过以下方式配置插件:
```json5
{
@ -353,9 +383,9 @@ Matrix 是当前的内置示例。如果恰好已经存在一个具名 Matrix
}
```
你的插件会在注册期间通过 `api.pluginConfig` 收到该配置。
你的插件会在注册期间通过 `api.pluginConfig` 接收这份配置。
对于渠道专属配置,请改用渠道配置部分
对于渠道专用配置,请改用渠道配置段
```json5
{
@ -368,10 +398,10 @@ Matrix 是当前的内置示例。如果恰好已经存在一个具名 Matrix
}
```
### 构建渠道配置 schema
### 构建渠道配置模式
使用 `openclaw/plugin-sdk/core` 中的 `buildChannelConfigSchema`
Zod schema 转换为 OpenClaw 可验证的 `ChannelConfigSchema` 包装器:
使用 `openclaw/plugin-sdk/core` 中的 `buildChannelConfigSchema`
将 Zod 模式转换为 OpenClaw 会验证的 `ChannelConfigSchema` 包装器:
```typescript
import { z } from "zod";
@ -398,8 +428,8 @@ import type { ChannelSetupWizard } from "openclaw/plugin-sdk/channel-setup";
const setupWizard: ChannelSetupWizard = {
channel: "my-channel",
status: {
configuredLabel: "已连接",
unconfiguredLabel: "未配置",
configuredLabel: "Connected",
unconfiguredLabel: "Not configured",
resolveConfigured: ({ cfg }) => Boolean((cfg.channels as any)?.["my-channel"]?.token),
},
credentials: [
@ -408,9 +438,9 @@ const setupWizard: ChannelSetupWizard = {
providerHint: "my-channel",
credentialLabel: "Bot token",
preferredEnvVar: "MY_CHANNEL_BOT_TOKEN",
envPrompt: "使用环境中的 MY_CHANNEL_BOT_TOKEN 吗?",
keepPrompt: "保留当前 token 吗?",
inputPrompt: "输入你的 bot token",
envPrompt: "Use MY_CHANNEL_BOT_TOKEN from environment?",
keepPrompt: "Keep current token?",
inputPrompt: "Enter your bot token:",
inspect: ({ cfg, accountId }) => {
const token = (cfg.channels as any)?.["my-channel"]?.token;
return {
@ -424,21 +454,22 @@ const setupWizard: ChannelSetupWizard = {
```
`ChannelSetupWizard` 类型支持 `credentials`、`textInputs`、
`dmPolicy`、`allowFrom`、`groupAccess`、`prepare`、`finalize` 等
完整示例请参内置插件包(例如 Discord 插件的 `src/channel.setup.ts`)。
`dmPolicy`、`allowFrom`、`groupAccess`、`prepare`、`finalize` 等。
完整示例请参内置插件包(例如 Discord 插件的 `src/channel.setup.ts`)。
对于需要标准
`note -> prompt -> parse -> merge -> patch` 流程的私信白名单提示,应优先使用
`openclaw/plugin-sdk/setup` 中的共享设置辅助工具:
对于需要标准
`note -> prompt -> parse -> merge -> patch` 流程的私信白名单提示,
优先使用 `openclaw/plugin-sdk/setup` 中的共享设置辅助工具:
`createPromptParsedAllowFromForAccount(...)`
`createTopLevelChannelParsedAllowFromPrompt(...)`
`createNestedChannelParsedAllowFromPrompt(...)`
对于仅在标签、分数和可选附加行方面有所不同的渠道设置状态块,应优先使用
`openclaw/plugin-sdk/setup` 中的
`createStandardChannelSetupStatus(...)`,而不是在每个插件中手写相同的 `status` 对象。
对于仅在标签、分数和可选附加行上有所不同的渠道设置状态块,
优先使用 `openclaw/plugin-sdk/setup` 中的
`createStandardChannelSetupStatus(...)`
而不是在每个插件中手写相同的 `status` 对象。
对于只应在某些上下文中显示的可选设置界面,请使用
对于只应在特定上下文中出现的可选设置界面,请使用
`openclaw/plugin-sdk/channel-setup` 中的
`createOptionalChannelSetupSurface`
@ -451,26 +482,31 @@ const setupSurface = createOptionalChannelSetupSurface({
npmSpec: "@myorg/openclaw-my-channel",
docsPath: "/channels/my-channel",
});
// 返回 { setupAdapter, setupWizard }
// Returns { setupAdapter, setupWizard }
```
`plugin-sdk/channel-setup` 还暴露了更底层的
`createOptionalChannelSetupAdapter(...)`
`createOptionalChannelSetupWizard(...)` 构建器,用于你只需要该可选安装界面其中一半能力的场景。
`createOptionalChannelSetupWizard(...)` 构建器,
适用于你只需要该可选安装界面其中一半的情况。
生成的可选适配器 / 向导在真实配置写入时会默认拒绝失败关闭。它们会在
`validateInput`、`applyAccountConfig` 和 `finalize` 之间复用一条“需要安装”的提示信息,并在设置了 `docsPath` 时附加文档链接。
生成的可选适配器/向导在真实配置写入时会以安全关闭方式失败。
它们会在 `validateInput`、`applyAccountConfig` 和 `finalize`
之间复用同一条“需要安装”的消息,并在设置了 `docsPath` 时附加文档链接。
对于由二进制驱动的设置 UI应优先使用共享的委托辅助工具而不是在每个渠道中复制相同的二进制 / 状态粘合逻辑:
对于由二进制程序支持的设置 UI优先使用共享的委托辅助工具
而不是把相同的二进制/状态胶水逻辑复制到每个渠道中:
- `createDetectedBinaryStatus(...)`:用于仅在标签、提示、分数和二进制检测上有所不同的状态块
- `createCliPathTextInput(...)`:用于基于路径的文本输入
- `createDetectedBinaryStatus(...)`用于仅在标签、提示、分数和二进制检测上不同的状态块
- `createCliPathTextInput(...)`用于基于路径的文本输入
- `createDelegatedSetupWizardStatusResolvers(...)`
`createDelegatedPrepare(...)`、`createDelegatedFinalize(...)` 和
`createDelegatedResolveConfigured(...)`:用于当 `setupEntry` 需要惰性转发到更重的完整向导时
- `createDelegatedTextInputShouldPrompt(...)`:用于当 `setupEntry` 只需要委托 `textInputs[*].shouldPrompt` 决策时
`createDelegatedResolveConfigured(...)`:适用于当 `setupEntry`
需要惰性转发到更重的完整向导时
- `createDelegatedTextInputShouldPrompt(...)`:适用于当 `setupEntry`
只需要委托 `textInputs[*].shouldPrompt` 决策时
## 发布与安装
## 发布安装
**外部插件:** 发布到 [ClawHub](/zh-CN/tools/clawhub) 或 npm然后安装
@ -478,13 +514,15 @@ const setupSurface = createOptionalChannelSetupSurface({
openclaw plugins install @myorg/openclaw-my-plugin
```
OpenClaw 会先尝试 ClawHub并在失败后自动回退到 npm。你也可以显式强制使用 ClawHub
OpenClaw 会先尝试 ClawHub失败后再自动回退到 npm。
你也可以显式强制使用 ClawHub
```bash
openclaw plugins install clawhub:@myorg/openclaw-my-plugin # ClawHub
openclaw plugins install clawhub:@myorg/openclaw-my-plugin # ClawHub only
```
没有对应的 `npm:` 覆盖写法。当你希望在 ClawHub 回退后走 npm 路径时,请使用普通的 npm 包 spec
没有对应的 `npm:` 覆盖方式。当你希望在 ClawHub 回退之后走 npm 路径时,
请使用普通的 npm 包 spec
```bash
openclaw plugins install @myorg/openclaw-my-plugin
@ -492,7 +530,7 @@ openclaw plugins install @myorg/openclaw-my-plugin
**仓库内插件:** 放在内置插件工作区树下,构建期间会自动发现。
**用户可安装:**
**用户可安装:**
```bash
openclaw plugins install <package-name>
@ -500,13 +538,19 @@ openclaw plugins install <package-name>
<Info>
对于来源于 npm 的安装,`openclaw plugins install` 会运行
`npm install --ignore-scripts`(不执行 lifecycle scripts。请保持插件依赖树为纯 JS / TS并避免使用需要 `postinstall` 构建的包。
`npm install --ignore-scripts`(不执行生命周期脚本)。
请保持插件依赖树为纯 JS/TS并避免依赖那些需要 `postinstall`
构建的包。
</Info>
内置的 OpenClaw 自有插件是唯一的启动修复例外:当打包安装检测到某个插件已通过插件配置、旧版渠道配置或其内置默认启用清单启用时,启动流程会在导入前为该插件安装缺失的运行时依赖。第三方插件不应依赖启动期安装;请继续使用显式的插件安装器。
只有 OpenClaw 自有的内置插件属于启动修复的例外情况:
当打包安装检测到某个插件已通过插件配置、旧版渠道配置,
或其内置的默认启用清单被启用时,
启动过程会在导入前安装该插件缺失的运行时依赖。
第三方插件不应依赖启动期安装;请继续使用显式的插件安装器。
## 相关内容
- [SDK 概览 入口点](/zh-CN/plugins/sdk-entrypoints) -- `definePluginEntry``defineChannelPluginEntry`
- [插件清单](/zh-CN/plugins/manifest) -- 完整清单 schema 参考
- [构建插件](/zh-CN/plugins/building-plugins) -- 分步入门指南
- [SDK 概览](/zh-CN/plugins/sdk-entrypoints) -- `definePluginEntry``defineChannelPluginEntry`
- [插件清单](/zh-CN/plugins/manifest) -- 完整清单模式参考
- [构建插件](/zh-CN/plugins/building-plugins) -- 分步入门指南