--- read_when: - 你正在构建一个 OpenClaw 插件 - 你需要发布插件配置架构或调试插件验证错误 summary: 插件清单 + JSON Schema 要求（严格配置验证） title: 插件清单 x-i18n: generated_at: "2026-07-11T20:44:39Z" model: gpt-5.6 postprocess_version: locale-links-v1 provider: openai source_hash: cd4ab5b10108585abb9a83a416b129e6f6351023016064b5d64b66aeabd04b2f source_path: plugins/manifest.md workflow: 16 --- 此页面介绍**原生 OpenClaw 插件清单** `openclaw.plugin.json`。有关兼容的捆绑包布局（Codex、Claude、Cursor），请参阅[插件捆绑包](/zh-CN/plugins/bundles)。 兼容的捆绑包格式改用各自的清单文件： - Codex 捆绑包：`.codex-plugin/plugin.json` - Claude 捆绑包：`.claude-plugin/plugin.json`，或不含清单的默认 Claude 组件布局 - Cursor 捆绑包：`.cursor-plugin/plugin.json` OpenClaw 会自动检测这些布局，但不会使用下方的 `openclaw.plugin.json` schema 验证它们。对于兼容的捆绑包，当布局符合 OpenClaw 的运行时要求时，OpenClaw 会读取捆绑包元数据、声明的 Skills 根目录、Claude 命令根目录、Claude `settings.json` 默认值、Claude LSP 默认值以及受支持的钩子包。 每个原生 OpenClaw 插件都**必须**在**插件根目录**中提供 `openclaw.plugin.json`。OpenClaw 会读取该文件，以便在**不执行插件代码**的情况下验证配置。清单缺失或无效会阻止配置验证，并被视为插件错误。 有关完整的插件系统指南，请参阅[插件](/zh-CN/tools/plugin)；有关原生能力模型和当前的外部兼容性指南，请参阅[能力模型](/zh-CN/plugins/architecture#public-capability-model)。 ## 此文件的作用 `openclaw.plugin.json` 是 OpenClaw 在**加载你的插件代码之前**读取的元数据。其中的所有内容都必须足够轻量，无需启动插件运行时即可检查。 **用于：** - 插件标识、配置验证和配置 UI 提示 - 身份验证、新手引导和设置元数据（别名、自动启用、提供商环境变量、身份验证选项） - 控制平面界面的激活提示 - 模型系列所有权的简写形式 - 静态能力所有权快照（`contracts`） - 共享 `openclaw qa` 主机可检查的 QA 运行程序元数据 - 合并到目录和验证界面中的渠道特定配置元数据 **请勿用于：**注册运行时行为、声明代码入口点或 npm 安装元数据。这些内容应放在你的插件代码和 `package.json` 中。 ## 最小示例 ```json { "id": "voice-call", "configSchema": { "type": "object", "additionalProperties": false, "properties": {} } } ``` ## 完整示例 ```json { "id": "openrouter", "name": "OpenRouter", "description": "OpenRouter provider plugin", "version": "1.0.0", "providers": ["openrouter"], "modelSupport": { "modelPrefixes": ["router-"] }, "modelIdNormalization": { "providers": { "openrouter": { "prefixWhenBare": "openrouter" } } }, "providerEndpoints": [ { "endpointClass": "openrouter", "hostSuffixes": ["openrouter.ai"] } ], "providerRequest": { "providers": { "openrouter": { "family": "openrouter" } } }, "cliBackends": ["openrouter-cli"], "syntheticAuthRefs": ["openrouter-cli"], "setup": { "providers": [ { "id": "openrouter", "envVars": ["OPENROUTER_API_KEY"] } ] }, "providerAuthAliases": { "openrouter-coding": "openrouter" }, "channelEnvVars": { "openrouter-chatops": ["OPENROUTER_CHATOPS_TOKEN"] }, "providerAuthChoices": [ { "provider": "openrouter", "method": "api-key", "choiceId": "openrouter-api-key", "choiceLabel": "OpenRouter API key", "groupId": "openrouter", "groupLabel": "OpenRouter", "optionKey": "openrouterApiKey", "cliFlag": "--openrouter-api-key", "cliOption": "--openrouter-api-key ", "cliDescription": "OpenRouter API key", "onboardingScopes": ["text-inference"] } ], "uiHints": { "apiKey": { "label": "API key", "placeholder": "sk-or-v1-...", "sensitive": true } }, "configSchema": { "type": "object", "additionalProperties": false, "properties": { "apiKey": { "type": "string" } } } } ``` ## 顶层字段参考 | 字段 | 必需 | 类型 | 含义 | | ------------------------------------ | ---- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | 是 | `string` | 规范插件 ID。此 ID 用于 `plugins.entries.`。 | | `configSchema` | 是 | `object` | 此插件配置的内联 JSON Schema。 | | `requiresPlugins` | 否 | `string[]` | 为使此插件生效而必须同时安装的插件 ID。设备发现会让插件保持可加载状态，但缺少任何必需插件时会发出警告。 | | `enabledByDefault` | 否 | `true` | 将内置插件标记为默认启用。省略此字段或设置任何非 `true` 值，可让插件默认保持禁用。 | | `enabledByDefaultOnPlatforms` | 否 | `string[]` | 将内置插件标记为仅在列出的 Node.js 平台上默认启用，例如 `["darwin"]`。显式配置仍具有更高优先级。 | | `legacyPluginIds` | 否 | `string[]` | 归一化为此规范插件 ID 的旧版 ID。 | | `autoEnableWhenConfiguredProviders` | 否 | `string[]` | 当身份验证、配置或模型引用提及这些提供商 ID 时，应自动启用此插件。 | | `kind` | 否 | `PluginKind \| PluginKind[]` | 声明由 `plugins.slots.*` 使用的一种或多种互斥插件类型（`"memory"`、`"context-engine"`）。同时拥有两个槽位的插件在同一个数组中声明这两种类型。 | | `channels` | 否 | `string[]` | 此插件拥有的渠道 ID。用于设备发现和配置验证。 | | `providers` | 否 | `string[]` | 此插件拥有的提供商 ID。 | | `providerCatalogEntry` | 否 | `string` | 相对于插件根目录的轻量级提供商目录模块路径，用于清单范围内的提供商目录元数据；无需激活完整插件运行时即可加载。 | | `modelSupport` | 否 | `object` | 由清单拥有的模型系列简写元数据，用于在运行时启动前自动加载插件。 | | `modelCatalog` | 否 | `object` | 此插件所拥有提供商的声明式模型目录元数据。这是未来无需加载插件运行时即可进行只读列表展示、新手引导、模型选择、别名处理和抑制的控制平面契约。 | | `modelPricing` | 否 | `object` | 由提供商拥有的外部定价查询策略。可使用它让本地或自托管提供商不使用远程定价目录，或者将提供商引用映射到 OpenRouter/LiteLLM 目录 ID，而无需在核心中硬编码提供商 ID。 | | `modelIdNormalization` | 否 | `object` | 由提供商拥有的模型 ID 别名和前缀清理规则，必须在提供商运行时加载前执行。 | | `providerEndpoints` | 否 | `object[]` | 由清单拥有的端点主机和 `baseUrl` 元数据，用于核心必须在提供商运行时加载前分类的提供商路由。 | | `providerRequest` | 否 | `object` | 轻量级提供商系列和请求兼容性元数据，供通用请求策略在提供商运行时加载前使用。 | | `secretProviderIntegrations` | 否 | `Record` | 声明式 SecretRef Exec 提供商预设，使设置或安装界面无需在核心中硬编码提供商特定集成即可提供这些选项。 | | `cliBackends` | 否 | `string[]` | 此插件拥有的 CLI 推理后端 ID。用于根据显式配置引用在启动时自动激活。 | | `syntheticAuthRefs` | 否 | `string[]` | 提供商或 CLI 后端引用；在运行时加载前进行冷模型发现期间，应探测其由插件拥有的合成身份验证钩子。 | | `nonSecretAuthMarkers` | 否 | `string[]` | 由内置插件拥有的占位 API 密钥值，表示非机密的本地、OAuth 或环境凭据状态。 | | `commandAliases` | 否 | `object[]` | 此插件拥有的命令名称，应在运行时加载前生成可感知插件的配置和 CLI 诊断信息。 | | `providerAuthEnvVars` | 否 | `Record` | 已弃用的提供商身份验证和状态查询兼容性环境变量元数据。新插件应优先使用 `setup.providers[].envVars`；在弃用窗口期内，OpenClaw 仍会读取此字段。 | | `providerUsageAuthEnvVars` | 否 | `Record` | 仅用于用量或计费的提供商凭据。OpenClaw 使用这些名称进行用量发现和机密清理，但绝不将其用于推理身份验证。 | | `providerAuthAliases` | 否 | `Record` | 应复用另一个提供商 ID 进行身份验证查询的提供商 ID，例如共享基础提供商 API 密钥和身份验证配置文件的编程提供商。 | | `channelEnvVars` | 否 | `Record` | OpenClaw 无需加载插件代码即可检查的轻量级渠道环境变量元数据。将其用于由环境变量驱动的渠道设置或通用启动与配置辅助工具应能识别的身份验证界面。 | | `providerAuthChoices` | 否 | `object[]` | 用于新手引导选择器、首选提供商解析和简单 CLI 标志绑定的轻量级身份验证选项元数据。 | | `activation` | 否 | `object` | 用于启动以及由提供商、命令、渠道、路由和能力触发加载的轻量级激活规划器元数据。仅包含元数据；实际行为仍由插件运行时负责。 | | `setup` | 否 | `object` | 设备发现和设置界面无需加载插件运行时即可检查的轻量级设置与新手引导描述符。 | | `qaRunners` | 否 | `object[]` | 共享的 `openclaw qa` 主机在插件运行时加载前使用的轻量级 QA 运行器描述符。 | | `contracts` | 否 | `object` | 外部身份验证钩子、嵌入、语音、实时转录、实时语音、媒体理解、图像/视频/音乐生成、网页获取、网页搜索、工作节点提供商、文档/网页内容提取以及工具所有权的静态能力所有权快照。 | | `configContracts` | 否 | `object` | 由清单拥有并供通用核心辅助工具使用的配置行为：危险标志检测、SecretRef 迁移目标和旧版配置路径收窄。请参阅 [configContracts 参考](#configcontracts-reference)。 | | `mediaUnderstandingProviderMetadata` | 否 | `Record` | 为 `contracts.mediaUnderstandingProviders` 中声明的提供商 ID 提供低开销的媒体理解默认元数据。 | | `imageGenerationProviderMetadata` | 否 | `Record` | 为 `contracts.imageGenerationProviders` 中声明的提供商 ID 提供低开销的图像生成身份验证元数据，包括提供商自有的身份验证别名和基础 URL 防护规则。 | | `videoGenerationProviderMetadata` | 否 | `Record` | 为 `contracts.videoGenerationProviders` 中声明的提供商 ID 提供低开销的视频生成身份验证元数据，包括提供商自有的身份验证别名和基础 URL 防护规则。 | | `musicGenerationProviderMetadata` | 否 | `Record` | 为 `contracts.musicGenerationProviders` 中声明的提供商 ID 提供低开销的音乐生成身份验证元数据，包括提供商自有的身份验证别名和基础 URL 防护规则。 | | `toolMetadata` | 否 | `Record` | 为 `contracts.tools` 中声明的插件自有工具提供低开销的可用性元数据。当工具仅应在存在配置、环境变量或身份验证凭据时加载运行时，请使用此项。 | | `channelConfigs` | 否 | `Record` | 清单自有的渠道配置元数据，在运行时加载前合并到设备发现和验证界面中。 | | `skills` | 否 | `string[]` | 要加载的 Skill 目录，相对于插件根目录。 | | `name` | 否 | `string` | 易于理解的插件名称。 | | `description` | 否 | `string` | 在插件界面中显示的简短摘要。 | | `catalog` | 否 | `object` | 插件目录界面的可选呈现提示。此元数据不会安装、启用插件，也不会授予插件信任。 | | `icon` | 否 | `string` | 用于市场和目录卡片的 HTTPS 图像 URL。ClawHub 接受任何有效的 `https://` URL；如果省略此项或其无效，则回退到默认插件图标。 | | `version` | 否 | `string` | 仅供参考的插件版本。 | | `uiHints` | 否 | `Record` | 配置字段的 UI 标签、占位符和敏感性提示。 | ## 目录参考 `catalog` 为插件浏览器提供可选的显示提示。宿主可以忽略这些提示。它们绝不会安装或启用插件，也不会改变插件的运行时行为或信任级别。 ```json { "catalog": { "featured": true, "order": 10 } } ``` | 字段 | 类型 | 含义 | | ---------- | --------- | ---------------------------------------------------------- | | `featured` | `boolean` | 目录界面是否应重点展示此插件。 | | `order` | `number` | 精选插件之间的升序显示提示；值越小，显示位置越靠前。 | ## 生成提供商元数据参考 生成提供商元数据字段描述匹配的 `contracts.*GenerationProviders` 列表中所声明提供商的静态身份验证信号。OpenClaw 会在提供商运行时加载之前读取这些字段，使核心工具无需导入每个提供商插件即可判断生成提供商是否可用。 这些字段仅用于成本低廉的声明式事实。传输、请求转换、令牌刷新、凭据验证和实际生成行为仍由插件运行时负责。 ```json { "contracts": { "imageGenerationProviders": ["example-image"] }, "imageGenerationProviderMetadata": { "example-image": { "aliases": ["example-image-oauth"], "authProviders": ["example-image"], "configSignals": [ { "rootPath": "plugins.entries.example-image.config", "overlayPath": "image", "mode": { "path": "mode", "default": "local", "allowed": ["local"] }, "requiredAny": ["workflow", "workflowPath"], "required": ["promptNodeId"] } ], "authSignals": [ { "provider": "example-image" }, { "provider": "example-image-oauth", "providerBaseUrl": { "provider": "example-image", "defaultBaseUrl": "https://api.example.com/v1", "allowedBaseUrls": ["https://api.example.com/v1"] } } ] } } } ``` 每个元数据条目支持： | 字段 | 必需 | 类型 | 含义 | | ---------------------- | ---- | ---------- | ------------------------------------------------------------------------------------------------------------ | | `aliases` | 否 | `string[]` | 应计为该生成提供商静态身份验证别名的其他提供商 ID。 | | `authProviders` | 否 | `string[]` | 其已配置身份验证配置文件应计为该生成提供商身份验证的提供商 ID。 | | `configSignals` | 否 | `object[]` | 面向无需身份验证配置文件或环境变量即可配置的本地或自托管提供商，仅检查配置的低成本可用性信号。 | | `authSignals` | 否 | `object[]` | 显式身份验证信号。存在时，这些信号会取代由提供商 ID、`aliases` 和 `authProviders` 构成的默认信号集。 | | `referenceAudioInputs` | 否 | `boolean` | 仅适用于视频生成。当提供商接受参考音频资源时设为 `true`；否则 `video_generate` 会隐藏音频参考参数。 | 每个 `configSignals` 条目支持： | 字段 | 必需 | 类型 | 含义 | | ---------------- | ---- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `rootPath` | 是 | `string` | 要检查的插件自有配置对象的点路径，例如 `plugins.entries.example.config`。 | | `overlayPath` | 否 | `string` | 根配置内部的点路径；评估信号前，应将该路径所指对象覆盖到根对象上。用于 `image`、`video` 或 `music` 等能力专属配置。 | | `overlayMapPath` | 否 | `string` | 根配置内部的点路径；该路径所指对象的每个值都应分别覆盖到根对象上。用于 `accounts` 等具名账户映射，其中任意已配置账户都应满足条件。 | | `required` | 否 | `string[]` | 有效配置内部必须具有已配置值的点路径。字符串必须非空；对象和数组不得为空。 | | `requiredAny` | 否 | `string[]` | 有效配置内部的点路径，其中至少一个必须具有已配置值。 | | `mode` | 否 | `object` | 有效配置内部的可选字符串模式约束。仅当只在某一种模式下适用纯配置可用性时使用。 | 每个 `mode` 约束支持： | 字段 | 必需 | 类型 | 含义 | | ------------ | ---- | ---------- | ------------------------------------------------------------------ | | `path` | 否 | `string` | 有效配置内部的点路径。默认为 `mode`。 | | `default` | 否 | `string` | 配置省略该路径时使用的模式值。 | | `allowed` | 否 | `string[]` | 存在时，仅当有效模式是这些值之一时，信号才通过。 | | `disallowed` | 否 | `string[]` | 存在时，当有效模式是这些值之一时，信号失败。 | 每个 `authSignals` 条目支持： | 字段 | 必需 | 类型 | 含义 | | ----------------- | ---- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `provider` | 是 | `string` | 要在已配置身份验证配置文件中检查的提供商 ID。 | | `providerBaseUrl` | 否 | `object` | 可选约束，仅当引用的已配置提供商使用允许的基础 URL 时，才计入该信号。当身份验证别名仅对某些 API 有效时使用。 | 每个 `providerBaseUrl` 约束支持： | 字段 | 必需 | 类型 | 含义 | | ----------------- | ---- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | | `provider` | 是 | `string` | 应检查其 `baseUrl` 的提供商配置 ID。 | | `defaultBaseUrl` | 否 | `string` | 提供商配置省略 `baseUrl` 时采用的基础 URL。 | | `allowedBaseUrls` | 是 | `string[]` | 此身份验证信号允许的基础 URL。当已配置或默认的基础 URL 与这些规范化值均不匹配时，忽略该信号。 | ## 工具元数据参考 `toolMetadata` 使用与生成提供商元数据相同的 `configSignals` 和 `authSignals` 结构，并以工具名称作为键。`contracts.tools` 声明所有权。`toolMetadata` 声明低成本的可用性证据，使 OpenClaw 不必仅仅为了让工具工厂返回 `null` 而导入插件运行时。 ```json { "setup": { "providers": [ { "id": "example", "envVars": ["EXAMPLE_API_KEY"] } ] }, "contracts": { "tools": ["example_search"] }, "toolMetadata": { "example_search": { "authSignals": [ { "provider": "example" } ], "configSignals": [ { "rootPath": "plugins.entries.example.config", "overlayPath": "search", "required": ["apiKey"] } ] } } } ``` 除上述共享的 `configSignals`/`authSignals` 字段外，`toolMetadata` 条目还接受 `optional`（将工具标记为插件激活时的非必需项）和 `replaySafe`（将工具执行标记为可在未完成的模型轮次后安全重复）。 如果工具没有 `toolMetadata`，OpenClaw 会保留现有行为，并在工具契约符合策略时加载所属插件。对于工具工厂依赖身份验证或配置的热路径工具，插件作者应声明 `toolMetadata`，而不是让核心导入运行时进行询问。 ## `providerAuthChoices` 参考 每个 `providerAuthChoices` 条目描述一个新手引导或身份验证选项。OpenClaw 会在提供商运行时加载之前读取它。提供商设置列表会使用这些清单选项、从描述符派生的设置选项以及安装目录元数据，而无需加载提供商运行时。 | 字段 | 必需 | 类型 | 含义 | | --------------------- | ---- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `provider` | 是 | `string` | 此选项所属的提供商 ID。 | | `method` | 是 | `string` | 要分派到的身份验证方法 ID。 | | `choiceId` | 是 | `string` | 新手引导和 CLI 流程使用的稳定身份验证选项 ID。 | | `choiceLabel` | 否 | `string` | 面向用户的标签。如果省略，OpenClaw 会回退到 `choiceId`。 | | `choiceHint` | 否 | `string` | 选取器的简短辅助文本。 | | `assistantPriority` | 否 | `number` | 在智能体驱动的交互式选取器中，值越小排序越靠前。 | | `assistantVisibility` | 否 | `"visible"` \| `"manual-only"` | 在智能体选取器中隐藏此选项，但仍允许通过 CLI 手动选择。 | | `deprecatedChoiceIds` | 否 | `string[]` | 应将用户重定向到此替代选项的旧版选项 ID。 | | `groupId` | 否 | `string` | 用于将相关选项分组的可选组 ID。 | | `groupLabel` | 否 | `string` | 该组面向用户的标签。 | | `groupHint` | 否 | `string` | 该组的简短辅助文本。 | | `onboardingFeatured` | 否 | `boolean` | 在交互式新手引导选取器的精选层级中显示此组，位于 "More..." 条目之前。 | | `optionKey` | 否 | `string` | 用于简单单标志身份验证流程的内部选项键。 | | `cliFlag` | 否 | `string` | CLI 标志名称，例如 `--openrouter-api-key`。 | | `cliOption` | 否 | `string` | 完整的 CLI 选项形式，例如 `--openrouter-api-key `。 | | `cliDescription` | 否 | `string` | CLI 帮助中使用的描述。 | | `onboardingScopes` | 否 | `Array<"text-inference" \| "image-generation" \| "music-generation">` | 此选项应出现在哪些新手引导界面中。如果省略，则默认为 `["text-inference"]`。 | ## `commandAliases` 参考 当插件拥有一个运行时命令名称，而用户可能误将其放入 `plugins.allow` 或尝试将其作为根 CLI 命令运行时，请使用 `commandAliases`。OpenClaw 使用此元数据进行诊断，无需导入插件运行时代码。 ```json { "commandAliases": [ { "name": "dreaming", "kind": "runtime-slash", "cliCommand": "memory" } ] } ``` | 字段 | 必需 | 类型 | 含义 | | ------------ | ---- | ----------------- | ------------------------------------------------------------------ | | `name` | 是 | `string` | 属于此插件的命令名称。 | | `kind` | 否 | `"runtime-slash"` | 将别名标记为聊天斜杠命令，而不是根 CLI 命令。 | | `cliCommand` | 否 | `string` | 用于 CLI 操作的相关根 CLI 建议命令（如果存在）。 | ## `activation` 参考 当插件能够以较低成本声明哪些控制平面事件应将其纳入激活/加载计划时，请使用 `activation`。 此块是规划器元数据，而不是生命周期 API。它不会注册运行时行为，不会取代 `register(...)`，也不保证插件代码已经执行。激活规划器使用这些字段缩小候选插件范围，然后才回退到现有的清单所有权元数据，例如 `providers`、`channels`、`commandAliases`、`setup.providers`、`contracts.tools` 和钩子。 优先使用已能描述所有权的最精确元数据。当 `providers`、`channels`、`commandAliases`、设置描述符或 `contracts` 能表达这种关系时，请使用这些字段。对于无法由这些所有权字段表示的额外规划器提示，请使用 `activation`。对于 `claude-cli`、`my-cli` 或 `google-gemini-cli` 等 CLI 运行时别名，请使用顶层 `cliBackends`；`activation.onAgentHarnesses` 仅用于尚无所有权字段的嵌入式 Agent harness ID。 每个插件都应有意设置 `activation.onStartup`。仅当插件必须在 Gateway 网关启动期间运行时，才将其设置为 `true`。当插件在启动时处于非活动状态，并且只应由更精确的触发器加载时，将其设置为 `false`。省略 `onStartup` 不再隐式地在启动时加载插件；请为启动、渠道、配置、Agent harness、记忆或其他更精确的激活触发器使用显式激活元数据。 ```json { "activation": { "onStartup": false, "onProviders": ["openai"], "onCommands": ["models"], "onChannels": ["web"], "onRoutes": ["gateway-webhook"], "onConfigPaths": ["browser"], "onCapabilities": ["provider", "tool"] } } ``` | 字段 | 必需 | 类型 | 含义 | | ------------------ | ---- | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `onStartup` | 否 | `boolean` | 显式的 Gateway 网关启动激活。每个插件都应设置此项。`true` 会在启动期间导入插件；`false` 会使其在启动时保持延迟加载，除非另一个匹配的触发器要求加载。 | | `onProviders` | 否 | `string[]` | 应将此插件纳入激活/加载计划的提供商 ID。 | | `onAgentHarnesses` | 否 | `string[]` | 应将此插件纳入激活/加载计划的嵌入式 Agent harness 运行时 ID。CLI 后端别名请使用顶层 `cliBackends`。 | | `onCommands` | 否 | `string[]` | 应将此插件纳入激活/加载计划的命令 ID。 | | `onChannels` | 否 | `string[]` | 应将此插件纳入激活/加载计划的渠道 ID。 | | `onRoutes` | 否 | `string[]` | 应将此插件纳入激活/加载计划的路由类型。 | | `onConfigPaths` | 否 | `string[]` | 相对于根的配置路径；当路径存在且未被显式禁用时，应将此插件纳入启动/加载计划。 | | `onCapabilities` | 否 | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 控制平面激活规划使用的宽泛能力提示。尽可能优先使用更精确的字段。 | 当前的实际使用方： - Gateway 网关启动规划使用 `activation.onStartup` 进行显式启动导入。 - 命令触发的 CLI 规划会回退到旧版 `commandAliases[].cliCommand` 或 `commandAliases[].name`。 - Agent 运行时启动规划对嵌入式 harness 使用 `activation.onAgentHarnesses`，对 CLI 运行时别名使用顶层 `cliBackends[]`。 - 当缺少显式渠道激活元数据时，渠道触发的设置/渠道规划会回退到旧版 `channels[]` 所有权。 - 启动插件规划对非渠道根配置界面使用 `activation.onConfigPaths`，例如内置浏览器插件的 `browser` 块。 - 当缺少显式提供商激活元数据时，提供商触发的设置/运行时规划会回退到旧版 `providers[]` 和顶层 `cliBackends[]` 所有权。 规划器诊断可以区分显式激活提示与清单所有权回退。例如，`activation-command-hint` 表示匹配了 `activation.onCommands`，而 `manifest-command-alias` 表示规划器改用了 `commandAliases` 所有权。这些原因标签用于宿主诊断和测试；插件作者应继续声明最能描述所有权的元数据。 ## `qaRunners` 参考 当插件在共享的 `openclaw qa` 根命令下提供一个或多个传输运行器时，请使用 `qaRunners`。请保持此元数据轻量且静态；插件运行时仍通过轻量级 `runtime-api.ts` 界面负责实际的 CLI 注册，该界面导出匹配的 `qaRunnerCliRegistrations`。可选的 `adapterFactory` 可将传输方式暴露给共享 QA 场景，而无需更改已注册命令的运行器。 ```json { "qaRunners": [ { "commandName": "matrix", "description": "Run the Docker-backed Matrix live QA lane against a disposable homeserver" } ] } ``` | 字段 | 必需 | 类型 | 含义 | | ------------- | ---- | -------- | ------------------------------------------------------------------ | | `commandName` | 是 | `string` | 挂载在 `openclaw qa` 下的子命令，例如 `matrix`。 | | `description` | 否 | `string` | 共享宿主需要占位命令时使用的后备帮助文本。 | `adapterFactory` id 必须与 `commandName` 匹配。不要为清单中不存在的命令导出注册项。 ## 设置参考 当设置和新手引导界面需要在运行时加载前获取开销较低且由插件所有的元数据时，请使用 `setup`。 ```json { "setup": { "providers": [ { "id": "openai", "authMethods": ["api-key"], "envVars": ["OPENAI_API_KEY"], "authEvidence": [ { "type": "local-file-with-env", "fileEnvVar": "OPENAI_CREDENTIALS_FILE", "requiresAllEnv": ["OPENAI_PROJECT"], "credentialMarker": "openai-local-credentials", "source": "openai local credentials" } ] } ], "cliBackends": ["openai-cli"], "configMigrations": ["legacy-openai-auth"], "requiresRuntime": false } } ``` 顶层 `cliBackends` 仍然有效，并继续描述 CLI 推理后端。`setup.cliBackends` 是特用于设置的描述符界面，供应保持仅使用元数据的控制平面和设置流程使用。 当 `setup.providers` 和 `setup.cliBackends` 存在时，它们是设置发现中首选的描述符优先查找界面。如果描述符只能缩小候选插件范围，而设置仍需要更丰富的设置阶段运行时钩子，请设置 `requiresRuntime: true`，并保留 `setup-api` 作为回退执行路径。 OpenClaw 还会将 `setup.providers[].envVars` 纳入通用提供商身份验证和环境变量查找。弃用期内仍通过兼容适配器支持 `providerAuthEnvVars`，但仍使用它的非内置插件会收到清单诊断。新插件应将设置和状态环境变量元数据放在 `setup.providers[].envVars` 中。 当计费或组织级凭据必须激活 `resolveUsageAuth`，但不应成为推理凭据时，请使用 `providerUsageAuthEnvVars`。这些名称会加入工作区 dotenv 阻止列表、ACP 子进程剥离、沙箱机密过滤和广泛的机密清理。提供商运行时仍会在 `resolveUsageAuth` 内读取并分类该值。 如果没有设置入口，或者 `setup.requiresRuntime: false` 声明不需要设置运行时，OpenClaw 也可以从 `setup.providers[].authMethods` 推导简单的设置选项。对于自定义标签、CLI 标志、新手引导范围和助手元数据，仍优先使用显式的 `providerAuthChoices` 条目。 仅当这些描述符足以满足设置界面的需求时，才设置 `requiresRuntime: false`。OpenClaw 将显式的 `false` 视为仅使用描述符的契约，不会为设置查找执行 `setup-api` 或 `openclaw.setupEntry`。如果仅使用描述符的插件仍提供其中一个设置运行时入口，OpenClaw 会报告附加诊断，并继续忽略该入口。省略 `requiresRuntime` 会保留旧版回退行为，因此，已经添加描述符但未添加此标志的现有插件不会中断。 由于设置查找可能执行插件所有的 `setup-api` 代码，因此规范化后的 `setup.providers[].id` 和 `setup.cliBackends[]` 值必须在发现的所有插件中保持唯一。所有权不明确时会采用失败关闭策略，而不是按照发现顺序选择一个胜出者。 当设置运行时确实执行时，如果 `setup-api` 注册了清单描述符未声明的提供商或 CLI 后端，或者描述符没有匹配的运行时注册项，设置注册表诊断会报告描述符漂移。这些诊断是附加的，不会拒绝旧版插件。 ### setup.providers 参考 | 字段 | 必需 | 类型 | 含义 | | -------------- | ---- | ---------- | -------------------------------------------------------------------------------------- | | `id` | 是 | `string` | 在设置或新手引导期间公开的提供商 id。确保规范化后的 id 在全局唯一。 | | `authMethods` | 否 | `string[]` | 无需加载完整运行时，此提供商即可支持的设置和身份验证方法 id。 | | `envVars` | 否 | `string[]` | 插件运行时加载前，通用设置和状态界面可以检查的环境变量。 | | `authEvidence` | 否 | `object[]` | 对可通过非机密标记进行身份验证的提供商执行的低开销本地身份验证证据检查。 | `authEvidence` 用于由提供商所有、无需加载运行时代码即可验证的本地凭据标记。这些检查必须保持低开销且仅限本地：不得进行网络调用、读取钥匙串或机密管理器、执行 shell 命令或探测提供商 API。 支持的证据条目： | 字段 | 必需 | 类型 | 含义 | | ------------------ | ---- | ---------- | -------------------------------------------------------------------------------------------------------- | | `type` | 是 | `string` | 当前为 `local-file-with-env`。 | | `fileEnvVar` | 否 | `string` | 包含显式凭据文件路径的环境变量。 | | `fallbackPaths` | 否 | `string[]` | 当 `fileEnvVar` 不存在或为空时检查的本地凭据文件路径。支持 `${HOME}` 和 `${APPDATA}`。 | | `requiresAnyEnv` | 否 | `string[]` | 列出的环境变量中至少一个必须非空，证据才有效。 | | `requiresAllEnv` | 否 | `string[]` | 列出的每个环境变量都必须非空，证据才有效。 | | `credentialMarker` | 是 | `string` | 存在证据时返回的非机密标记。 | | `source` | 否 | `string` | 用于身份验证和状态输出的面向用户的来源标签。 | ### setup 字段 | 字段 | 必需 | 类型 | 含义 | | ------------------ | ---- | ---------- | --------------------------------------------------------------------------------------------- | | `providers` | 否 | `object[]` | 在设置和新手引导期间公开的提供商设置描述符。 | | `cliBackends` | 否 | `string[]` | 用于描述符优先设置查找的设置阶段后端 id。确保规范化后的 id 在全局唯一。 | | `configMigrations` | 否 | `string[]` | 由此插件的设置界面所有的配置迁移 id。 | | `requiresRuntime` | 否 | `boolean` | 描述符查找后，设置是否仍需执行 `setup-api`。 | ## uiHints 参考 `uiHints` 是从配置字段名称到简短渲染提示的映射。键可以使用点号表示嵌套配置字段，但任何路径段都不得为 `__proto__`、`constructor` 或 `prototype`；设置流程会拒绝这些名称。 ```json { "uiHints": { "apiKey": { "label": "API key", "help": "Used for OpenRouter requests", "placeholder": "sk-or-v1-...", "sensitive": true } } } ``` 每个字段提示可以包括： | 字段 | 类型 | 含义 | | ------------- | ---------- | ---------------------------- | | `label` | `string` | 面向用户的字段标签。 | | `help` | `string` | 简短的辅助文本。 | | `tags` | `string[]` | 可选的 UI 标签。 | | `advanced` | `boolean` | 将字段标记为高级字段。 | | `sensitive` | `boolean` | 将字段标记为机密或敏感字段。 | | `placeholder` | `string` | 表单输入框的占位文本。 | ## contracts 参考 仅将 `contracts` 用于 OpenClaw 无需导入插件运行时即可读取的静态能力所有权元数据。 ```json { "contracts": { "agentToolResultMiddleware": ["openclaw", "codex"], "trustedToolPolicies": ["workflow-budget"], "externalAuthProviders": ["acme-ai"], "embeddingProviders": ["openai-compatible"], "speechProviders": ["openai"], "realtimeTranscriptionProviders": ["openai"], "realtimeVoiceProviders": ["openai"], "memoryEmbeddingProviders": ["local"], "mediaUnderstandingProviders": ["openai"], "imageGenerationProviders": ["openai"], "videoGenerationProviders": ["qwen"], "musicGenerationProviders": ["stability-audio"], "documentExtractors": ["example-docs"], "webContentExtractors": ["firecrawl"], "webFetchProviders": ["firecrawl"], "webSearchProviders": ["gemini"], "workerProviders": ["example-worker"], "usageProviders": ["acme-ai"], "migrationProviders": ["hermes"], "gatewayMethodDispatch": ["authenticated-request"], "tools": ["firecrawl_search", "firecrawl_scrape"] } } ``` 每个列表都是可选的： | 字段 | 类型 | 含义 | | -------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `embeddedExtensionFactories` | `string[]` | Codex app-server 扩展工厂 ID，目前为 `codex-app-server`。 | | `agentToolResultMiddleware` | `string[]` | 此插件可为其注册工具结果中间件的运行时 ID。 | | `trustedToolPolicies` | `string[]` | 已安装插件可注册的插件本地可信工具前策略 ID。内置插件无需此字段即可注册策略。 | | `externalAuthProviders` | `string[]` | 此插件所拥有其外部身份验证配置文件钩子的提供商 ID。 | | `embeddingProviders` | `string[]` | 此插件拥有的通用嵌入提供商 ID，用于可复用的向量嵌入，包括记忆。 | | `speechProviders` | `string[]` | 此插件拥有的语音提供商 ID。 | | `realtimeTranscriptionProviders` | `string[]` | 此插件拥有的实时转写提供商 ID。 | | `realtimeVoiceProviders` | `string[]` | 此插件拥有的实时语音提供商 ID。 | | `memoryEmbeddingProviders` | `string[]` | 此插件拥有的已弃用记忆专用嵌入提供商 ID。 | | `mediaUnderstandingProviders` | `string[]` | 此插件拥有的媒体理解提供商 ID。 | | `transcriptSourceProviders` | `string[]` | 此插件拥有的转写文本源提供商 ID。 | | `documentExtractors` | `string[]` | 此插件拥有的文档（例如 PDF）提取器提供商 ID。 | | `imageGenerationProviders` | `string[]` | 此插件拥有的图像生成提供商 ID。 | | `videoGenerationProviders` | `string[]` | 此插件拥有的视频生成提供商 ID。 | | `musicGenerationProviders` | `string[]` | 此插件拥有的音乐生成提供商 ID。 | | `webContentExtractors` | `string[]` | 此插件拥有的网页内容提取提供商 ID。 | | `webFetchProviders` | `string[]` | 此插件拥有的网页获取提供商 ID。 | | `webSearchProviders` | `string[]` | 此插件拥有的网页搜索提供商 ID。 | | `workerProviders` | `string[]` | 此插件拥有的云端工作节点提供商 ID，用于预置资源和由配置文件支持的租约生命周期。 | | `usageProviders` | `string[]` | 此插件所拥有其用量身份验证和用量快照钩子的提供商 ID。 | | `migrationProviders` | `string[]` | 此插件为 `openclaw migrate` 所拥有的导入提供商 ID。 | | `gatewayMethodDispatch` | `string[]` | 为经过身份验证、在进程内分派 Gateway 网关方法的插件 HTTP 路由保留的授权。 | | `tools` | `string[]` | 此插件拥有的智能体工具名称。 | `contracts.embeddedExtensionFactories` 保留用于内置的 Codex app-server 专用扩展工厂。内置工具结果转换应改为声明 `contracts.agentToolResultMiddleware`，并通过 `api.registerAgentToolResultMiddleware(...)` 注册。仅当显式启用且仅针对其在 `contracts.agentToolResultMiddleware` 中声明的运行时，已安装插件才可使用同一中间件接入点。 需要宿主可信工具前策略层级的已安装插件，必须在 `contracts.trustedToolPolicies` 中声明每个已注册的本地 ID，并且必须被显式启用。内置插件保留现有可信策略路径，但策略 ID 未声明的已安装插件会在注册前被拒绝。策略 ID 的作用域限定于注册该 ID 的插件，因此两个插件均可声明并注册 `workflow-budget`；但单个插件不得重复注册同一本地 ID。 运行时 `api.registerTool(...)` 注册必须与 `contracts.tools` 匹配。工具发现使用此列表，仅加载能够拥有所请求工具的插件运行时。 实现 `resolveExternalAuthProfiles` 的提供商插件应声明 `contracts.externalAuthProviders`；未声明的外部身份验证钩子会被忽略。 同时实现 `resolveUsageAuth` 和 `fetchUsageSnapshot` 的提供商插件，应在 `contracts.usageProviders` 中声明每个自动发现的提供商 ID。用量发现会在加载运行时代码前读取此契约，然后仅加载声明的所有者，并在加载后验证这两个钩子。 通用嵌入提供商应为通过 `api.registerEmbeddingProvider(...)` 注册的每个适配器声明 `contracts.embeddingProviders`。可复用向量生成应使用通用契约，包括供记忆搜索使用的提供商。`contracts.memoryEmbeddingProviders` 是已弃用的记忆专用兼容机制，仅在现有提供商迁移到通用嵌入提供商接入点期间保留。 工作节点提供商必须在 `contracts.workerProviders` 中声明每个 `api.registerWorkerProvider(...)` ID。核心在调用 `provision` 前持久化长期意图；提供商在分配外部资源前验证其设置，并且使用同一操作 ID 的重复调用必须采用同一租约。核心还会持久化经过验证的设置快照，并将其与 `leaseId` 一同传递给 `inspect({ leaseId, profile })` 和 `destroy({ leaseId, profile })`，即使具名配置文件已被更改或删除也是如此。销毁操作具有幂等性，检查操作返回封闭的 `active` / `destroyed` / `unknown` 状态联合类型，并且 SSH 私钥材料仅通过 `SecretRef` 引用。预置的 SSH 端点还必须包含来自可信预置输出的公开 `hostKey`，其格式必须严格为 `algorithm base64`，不得包含主机名或注释，以便核心在连接前固定主机密钥。生成动态身份引用的提供商可实现具有权威性的 `resolveSshIdentity({ leaseId, profile, keyRef })`；未实现该方法的提供商使用核心的通用密钥解析器。具有权威性的 `unknown` 会使活动的本地记录成为孤立记录；在持久化销毁请求后，该状态用于确认资源已拆除。 `contracts.gatewayMethodDispatch` 当前接受 `"authenticated-request"`。它是面向原生插件 HTTP 路由的 API 规范门控，这些路由有意在进程内分派 Gateway 网关控制平面方法；它并非用于防范恶意原生插件的沙箱。仅应将其用于经过严格审核、且已要求 Gateway 网关 HTTP 身份验证的内置或操作员界面。当 Gateway 网关根工作准入关闭时，获得授权的路由仅在同时声明 `auth: "gateway"` 和路由专用的 `gatewayRuntimeScopeSurface: "trusted-operator"` 时仍可访问；同一插件中的普通同级路由仍受准入边界限制。这样可以在不向整个插件授予准入绕过权限的情况下，确保暂停状态和恢复功能仍可访问。分派之外的解析和响应塑形应保持范围受限；实质性工作或变更性工作必须通过 Gateway 网关方法分派执行，由其负责准入和权限范围强制执行。 ## `configContracts` 参考 对于通用核心辅助函数无需导入插件运行时即可使用的、由清单拥有的配置行为，请使用 `configContracts`：危险标志检测、`SecretRef` 迁移目标以及旧版配置路径收窄。 ```json { "configContracts": { "compatibilityMigrationPaths": ["legacyProvider"], "compatibilityRuntimePaths": ["legacyProvider.webhook"], "dangerousFlags": [ { "path": "accounts.*.allowUnverifiedSenders", "equals": true } ], "secretInputs": { "bundledDefaultEnabled": false, "paths": [ { "path": "apiKey", "expected": "string" } ] } } } ``` | 字段 | 必需 | 类型 | 含义 | | ----------------------------- | ---- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `compatibilityMigrationPaths` | 否 | `string[]` | 表明此插件的设置阶段兼容性迁移可能适用的根相对配置路径。当配置从未引用该插件时，这可让通用运行时配置读取跳过该插件的所有设置界面。 | | `compatibilityRuntimePaths` | 否 | `string[]` | 在插件代码完全激活前，此插件可于运行时处理的根相对兼容性路径。对于应在不导入每个兼容插件运行时的情况下收窄内置候选集合的旧版界面，请使用此字段。 | | `dangerousFlags` | 否 | `object[]` | 启用时 `openclaw doctor` 应标记为不安全或危险的配置字面值。见下文。 | | `secretInputs` | 否 | `object` | 位于 `plugins.entries..config` 下，`SecretRef` 迁移/审计目标注册表应视为密钥形式字符串的配置路径。见下文。 | 每个 `dangerousFlags` 条目支持： | 字段 | 必需 | 类型 | 含义 | | -------- | ---- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `path` | 是 | `string` | 相对于 `plugins.entries..config`、以点分隔的配置路径。支持对映射/数组区段使用 `*` 通配符。 | | `equals` | 是 | `string \| number \| boolean \| null` | 将此配置值标记为危险的精确字面值。 | `secretInputs` 支持： | 字段 | 必需 | 类型 | 含义 | | ----------------------- | ---- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `bundledDefaultEnabled` | 否 | `boolean` | 在确定此 SecretRef 表面是否处于活动状态时，覆盖内置插件的默认启用状态。当插件为内置插件，但此表面应在配置中显式启用后才激活时使用。 | | `paths` | 是 | `object[]` | Secret 形态的配置路径；每项包含 `path`（以点分隔，相对于 `plugins.entries..config`，支持 `*` 通配符）以及可选的 `expected`（目前仅支持 `"string"`）。 | ## mediaUnderstandingProviderMetadata 参考 当媒体理解提供商具有默认模型、自动身份验证回退优先级或原生文档支持，且通用核心辅助函数需要在运行时加载前获知这些信息时，请使用 `mediaUnderstandingProviderMetadata`。相关键还必须在 `contracts.mediaUnderstandingProviders` 中声明。 ```json { "contracts": { "mediaUnderstandingProviders": ["example"] }, "mediaUnderstandingProviderMetadata": { "example": { "capabilities": ["image", "audio"], "defaultModels": { "image": "example-vision-latest", "audio": "example-transcribe-latest" }, "autoPriority": { "image": 40 }, "nativeDocumentInputs": ["pdf"], "documentModels": { "pdf": { "textExtraction": "example-doc-text-latest", "image": "example-doc-vision-latest" } } } } } ``` 每个提供商条目可包含： | 字段 | 类型 | 含义 | | ---------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `capabilities` | `("image" \| "audio" \| "video")[]` | 此提供商公开的媒体能力。 | | `defaultModels` | `Record` | 配置未指定模型时使用的能力到模型默认值映射。 | | `autoPriority` | `Record` | 基于凭据自动回退提供商时，数值越小排序越靠前。 | | `nativeDocumentInputs` | `"pdf"[]` | 提供商支持的原生文档输入。 | | `documentModels` | `{ pdf?: { textExtraction?: string; image?: string \| false } }` | 按文档类型设置的模型覆盖值。设置 `image: false` 可禁用该文档类型基于图像的提取。 | ## channelConfigs 参考 当渠道插件需要在运行时加载前获取低成本的配置元数据时，请使用 `channelConfigs`。对于已配置的外部渠道，如果没有可用的设置入口，或者 `setup.requiresRuntime: false` 声明设置不需要运行时，只读渠道设置/状态发现功能可以直接使用此元数据。 `channelConfigs` 是插件清单元数据，而不是新的顶层用户配置部分。用户仍在 `channels.` 下配置渠道实例。OpenClaw 会读取清单元数据，以便在插件运行时代码执行前确定哪个插件拥有已配置的渠道。 对于渠道插件，`configSchema` 和 `channelConfigs` 描述不同的路径： - `configSchema` 验证 `plugins.entries..config` - `channelConfigs..schema` 验证 `channels.` 声明了 `channels[]` 的非内置插件还应声明对应的 `channelConfigs` 条目。缺少这些条目时，OpenClaw 仍可加载插件，但在插件运行时执行前，冷路径配置架构、设置和 Control UI 表面无法获知该渠道所拥有的选项结构。 `channelConfigs..commands.nativeCommandsAutoEnabled` 和 `nativeSkillsAutoEnabled` 可以为渠道运行时加载前执行的命令配置检查声明静态 `auto` 默认值。内置渠道也可以通过 `package.json#openclaw.channel.commands` 发布相同的默认值，并与其由软件包拥有的其他渠道目录元数据放在一起。 ```json { "channelConfigs": { "matrix": { "schema": { "type": "object", "additionalProperties": false, "properties": { "homeserverUrl": { "type": "string" } } }, "uiHints": { "homeserverUrl": { "label": "Homeserver URL", "placeholder": "https://matrix.example.com" } }, "label": "Matrix", "description": "Matrix homeserver connection", "commands": { "nativeCommandsAutoEnabled": true, "nativeSkillsAutoEnabled": true }, "preferOver": ["matrix-legacy"] } } } ``` 每个渠道条目可包含： | 字段 | 类型 | 含义 | | ------------- | ------------------------ | ------------------------------------------------------------------------------------------ | | `schema` | `object` | `channels.` 的 JSON Schema。每个已声明的渠道配置条目都必须提供。 | | `uiHints` | `Record` | 该渠道配置部分的可选 UI 标签、占位符和敏感信息提示。 | | `label` | `string` | 运行时元数据尚未就绪时，合并到选择器和检查表面的渠道标签。 | | `description` | `string` | 用于检查和目录表面的简短渠道描述。 | | `commands` | `object` | 用于运行时前配置检查的静态原生命令和原生 Skills 自动默认值。 | | `preferOver` | `string[]` | 此渠道在选择表面中应优先于的旧版或低优先级插件 ID。 | ### 替换另一个渠道插件 当另一个插件也可以提供同一个渠道 ID，而你的插件应成为该渠道的首选所有者时，请使用 `preferOver`。常见情况包括插件 ID 已重命名、独立插件取代内置插件，或者维护中的分支为了配置兼容性而保留相同的渠道 ID。 ```json { "id": "acme-chat", "channels": ["chat"], "channelConfigs": { "chat": { "schema": { "type": "object", "additionalProperties": false, "properties": { "webhookUrl": { "type": "string" } } }, "preferOver": ["chat"] } } } ``` 配置 `channels.chat` 后，OpenClaw 会同时考虑渠道 ID 和首选插件 ID。如果低优先级插件仅因其为内置插件或默认启用而被选中，OpenClaw 会在有效运行时配置中禁用该插件，从而确保由一个插件拥有该渠道及其工具。显式用户选择仍然优先：如果用户显式启用了两个插件（通过 `plugins.allow` 或实质性的 `plugins.entries` 配置），OpenClaw 会保留该选择并报告渠道/工具重复诊断，而不会静默更改请求的插件集合。 请将 `preferOver` 的范围限制为确实能提供相同渠道的插件 ID。它不是通用优先级字段，也不会重命名用户配置键。 ## modelSupport 参考 当 OpenClaw 应在插件运行时加载前，根据 `gpt-5.6-sol` 或 `claude-sonnet-4.6` 等简写模型 ID 推断你的提供商插件时，请使用 `modelSupport`。 ```json { "modelSupport": { "modelPrefixes": ["gpt-", "o1", "o3", "o4"], "modelPatterns": ["^computer-use-preview"] } } ``` OpenClaw 按以下优先级处理： - 显式 `provider/model` 引用使用所属插件的 `providers` 清单元数据 - `modelPatterns` 优先于 `modelPrefixes` - 如果一个非内置插件和一个内置插件均匹配，则非内置插件优先 - 剩余的歧义会被忽略，直到用户或配置指定提供商 字段： | 字段 | 类型 | 含义 | | --------------- | ---------- | ---------------------------------------------------------------------------- | | `modelPrefixes` | `string[]` | 使用 `startsWith` 与简写模型 ID 匹配的前缀。 | | `modelPatterns` | `string[]` | 移除配置文件后缀后，与简写模型 ID 匹配的正则表达式源。 | `modelPatterns` 条目通过 `compileSafeRegex` 编译，该函数会拒绝包含嵌套重复的模式（例如 `(a+)+$`）。未通过安全检查的模式会被静默跳过，与语法无效的正则表达式相同。请保持模式简单，并避免使用嵌套量词。 ## modelCatalog 参考 当 OpenClaw 应在加载插件运行时前获知提供商模型元数据时，请使用 `modelCatalog`。它是固定目录行、提供商别名、抑制规则和发现模式的清单所属来源。运行时刷新仍由提供商运行时代码负责，但清单会告知核心何时需要运行时。 ```json { "providers": ["openai"], "modelCatalog": { "providers": { "openai": { "baseUrl": "https://api.openai.com/v1", "api": "openai-responses", "models": [ { "id": "gpt-5.4", "name": "GPT-5.4", "input": ["text", "image"], "reasoning": true, "contextWindow": 256000, "maxTokens": 128000, "cost": { "input": 1.25, "output": 10, "cacheRead": 0.125 }, "status": "available", "tags": ["default"] } ] } }, "aliases": { "azure-openai-responses": { "provider": "openai", "api": "azure-openai-responses" } }, "suppressions": [ { "provider": "azure-openai-responses", "model": "gpt-5.3-codex-spark", "reason": "not available on Azure OpenAI Responses" } ], "discovery": { "openai": "static" } } } ``` 顶层字段： | 字段 | 类型 | 含义 | | ---------------- | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `providers` | `Record` | 此插件所拥有的提供商 ID 对应的目录条目。键也应出现在顶层 `providers` 中。 | | `aliases` | `Record` | 在目录规划或抑制规划中，应解析为某个已归属提供商的提供商别名。 | | `suppressions` | `object[]` | 此插件因提供商特定原因而抑制的其他来源模型条目。 | | `discovery` | `Record` | 提供商目录是否可从清单元数据读取、可刷新到缓存，或必须通过运行时获取。 | | `runtimeAugment` | `boolean` | 仅当提供商运行时必须在清单/配置规划完成后追加目录条目时，才设为 `true`。 | `aliases` 参与模型目录规划中的提供商归属查找。别名目标必须是由同一插件拥有的顶层提供商。当按提供商筛选的列表使用别名时，OpenClaw 无需加载提供商运行时，即可读取归属清单并应用别名的 API/基础 URL 覆盖。别名不会扩展未筛选的目录列表；宽泛列表只会输出归属方的规范提供商条目。 `suppressions` 取代旧的提供商运行时 `suppressBuiltInModel` 钩子。仅当提供商归此插件所有，或被声明为指向已归属提供商的 `modelCatalog.aliases` 键时，抑制条目才会生效。在模型解析期间，不再调用运行时抑制钩子。 提供商字段： | 字段 | 类型 | 含义 | | --------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `baseUrl` | `string` | 此提供商目录中模型的可选默认基础 URL。 | | `api` | `ModelApi` | 此提供商目录中模型的可选默认 API 适配器。 | | `headers` | `Record` | 应用于此提供商目录的可选静态请求头。 | | `defaultUtilityModel` | `string` | 提供商为短时内部实用任务（标题、进度叙述）推荐的可选小模型 ID。当 `agents.defaults.utilityModel` 未设置，且此提供商为智能体的主模型提供服务时使用。 | | `models` | `object[]` | 必需的模型条目。没有 `id` 的条目将被忽略。 | 模型字段： | 字段 | 类型 | 含义 | | ------------------ | -------------------------------------------------------------- | --------------------------------------------------------------------------- | | `id` | `string` | 提供商本地模型 ID，不含 `provider/` 前缀。 | | `name` | `string` | 可选显示名称。 | | `api` | `ModelApi` | 可选的单模型 API 覆盖。 | | `baseUrl` | `string` | 可选的单模型基础 URL 覆盖。 | | `headers` | `Record` | 可选的单模型静态请求头。 | | `input` | `Array<"text" \| "image" \| "document">` | 模型接受的模态。其他值会被静默丢弃。 | | `reasoning` | `boolean` | 模型是否提供推理行为。 | | `contextWindow` | `number` | 提供商原生上下文窗口。 | | `contextTokens` | `number` | 当与 `contextWindow` 不同时，可选的有效运行时上下文上限。 | | `maxTokens` | `number` | 已知时的最大输出 token 数。 | | `thinkingLevelMap` | `Record` | 可选的各思考级别模型 ID 或参数覆盖。 | | `cost` | `object` | 可选的每百万 token 美元定价，包括可选的 `tieredPricing`。 | | `compat` | `object` | 与 OpenClaw 模型配置兼容性相匹配的可选兼容性标志。 | | `mediaInput` | `object` | 可选的各模态输入配置，目前仅支持图像。 | | `status` | `"available"` \| `"preview"` \| `"deprecated"` \| `"disabled"` | 列表状态。仅当条目完全不应出现时才进行抑制。 | | `statusReason` | `string` | 随非可用状态显示的可选原因。 | | `replaces` | `string[]` | 此模型所取代的旧提供商本地模型 ID。 | | `replacedBy` | `string` | 已弃用条目的替代提供商本地模型 ID。 | | `tags` | `string[]` | 选择器和筛选器使用的稳定标签。 | 抑制字段： | 字段 | 类型 | 含义 | | -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------ | | `provider` | `string` | 要抑制的上游条目所属的提供商 ID。必须归此插件所有，或声明为归此插件所有的别名。 | | `model` | `string` | 要抑制的提供商本地模型 ID。 | | `reason` | `string` | 直接请求被抑制条目时显示的可选消息。 | | `when.baseUrlHosts` | `string[]` | 应用抑制前必须匹配的可选有效提供商基础 URL 主机列表。 | | `when.providerConfigApiIn` | `string[]` | 应用抑制前必须匹配的提供商配置 `api` 精确值的可选列表。 | 不要在 `modelCatalog` 中放置仅供运行时使用的数据。仅当清单条目足够完整，使按提供商筛选的列表和选择器界面可以跳过注册表/运行时发现时，才使用 `static`。当清单条目可作为有用的可列出种子或补充，但后续刷新/缓存还可添加更多条目时，使用 `refreshable`；可刷新条目本身并非权威数据。当 OpenClaw 必须加载提供商运行时才能获知列表时，使用 `runtime`。 ## modelIdNormalization 参考 使用 `modelIdNormalization` 执行开销较低且由提供商负责的模型 ID 清理，并且必须在提供商运行时加载前完成。这样可将短模型名称、提供商本地旧版 ID 和代理前缀规则等别名保留在归属插件的清单中，而不是放入核心模型选择表。 ```json { "providers": ["anthropic", "openrouter"], "modelIdNormalization": { "providers": { "anthropic": { "aliases": { "sonnet-4.6": "claude-sonnet-4-6" } }, "openrouter": { "prefixWhenBare": "openrouter" } } } } ``` 提供商字段： | 字段 | 类型 | 含义 | | ------------------------------------ | ----------------------- | ------------------------------------------------------------------------------------- | | `aliases` | `Record` | 不区分大小写的精确模型 ID 别名。值会按原样返回。 | | `stripPrefixes` | `string[]` | 在查找别名前移除的前缀，适用于旧版提供商/模型重复情况。 | | `prefixWhenBare` | `string` | 当规范化后的模型 ID 尚未包含 `/` 时添加的前缀。 | | `prefixWhenBareAfterAliasStartsWith` | `object[]` | 别名查找后的条件式裸 ID 前缀规则，以 `modelPrefix` 和 `prefix` 为键。 | ## providerEndpoints 参考 使用 `providerEndpoints` 进行端点分类，这是通用请求策略在提供商运行时加载前必须获知的信息。核心仍负责定义每个 `endpointClass` 的含义；插件清单负责主机和基础 URL 元数据。 已正式外置的提供商插件不包含在核心发行包中，因此在安装前无法看到它们的清单。它们的 `providerEndpoints` 还必须镜像到 `scripts/lib/official-external-provider-catalog.json`，以便在没有插件时端点分类仍可正常工作；契约测试会强制校验此镜像。 端点字段： | 字段 | 类型 | 含义 | | ------------------------------ | ---------- | ----------------------------------------------------------------------------------------- | | `endpointClass` | `string` | 已知的核心端点类别，例如 `openrouter`、`moonshot-native` 或 `google-vertex`。 | | `hosts` | `string[]` | 映射到该端点类别的精确主机名。 | | `hostSuffixes` | `string[]` | 映射到该端点类别的主机后缀。以 `.` 开头时，仅匹配域名后缀。 | | `baseUrls` | `string[]` | 映射到该端点类别的精确规范化 HTTP(S) 基础 URL。 | | `googleVertexRegion` | `string` | 精确全局主机所对应的静态 Google Vertex 区域。 | | `googleVertexRegionHostSuffix` | `string` | 从匹配的主机中移除的后缀，以提取 Google Vertex 区域前缀。 | ## `providerRequest` 参考 当通用请求策略需要低开销的请求兼容性元数据，而又不希望加载提供商运行时时，请使用 `providerRequest`。特定于行为的载荷重写应保留在提供商运行时钩子或共享的提供商系列辅助函数中。 ```json { "providerRequest": { "providers": { "vllm": { "family": "vllm", "openAICompletions": { "supportsStreamingUsage": true } } } } } ``` 提供商字段： | 字段 | 类型 | 含义 | | --------------------- | ------------ | -------------------------------------------------------------------------------------- | | `family` | `string` | 通用请求兼容性决策和诊断所使用的提供商系列标签。 | | `compatibilityFamily` | `"moonshot"` | 可选的提供商系列兼容性分组，供共享请求辅助函数使用。 | | `openAICompletions` | `object` | OpenAI 兼容的补全请求标志，目前为 `supportsStreamingUsage`。 | ## `secretProviderIntegrations` 参考 当插件可以发布可复用的 SecretRef Exec 提供商预设时，请使用 `secretProviderIntegrations`。OpenClaw 会在插件运行时加载之前读取此元数据，将插件所有权存储在 `secrets.providers..pluginIntegration` 中，并将实际的密钥解析交给 SecretRef 运行时。预设仅对内置插件以及从托管插件安装根目录中发现的已安装插件公开，例如通过 git 和 ClawHub 安装的插件。 ```json { "secretProviderIntegrations": { "secret-store": { "providerAlias": "team-secrets", "displayName": "Team secrets", "source": "exec", "command": "${node}", "args": ["./bin/resolve-secrets.mjs"] } } } ``` 映射键是集成 ID。如果省略 `providerAlias`，OpenClaw 会使用集成 ID 作为 SecretRef 提供商别名。提供商别名必须符合常规的 SecretRef 提供商别名模式，例如 `team-secrets` 或 `onepassword-work`。 当操作员选择该预设时，OpenClaw 会写入类似以下内容的提供商引用： ```json { "secrets": { "providers": { "team-secrets": { "source": "exec", "pluginIntegration": { "pluginId": "acme-secrets", "integrationId": "secret-store" } } } } } ``` 在启动或重新加载时，OpenClaw 会通过加载当前插件清单元数据来解析该提供商，检查所属插件是否已安装且处于活动状态，并根据清单具体化 Exec 命令。禁用或移除插件会撤销活动 SecretRef 所使用的该提供商。需要独立 Exec 配置的操作员仍可直接编写包含手动 `command`/`args` 的提供商。 目前仅支持 `source: "exec"` 预设。`command` 必须为 `${node}`，且 `args[0]` 必须是以 `./` 开头、相对于插件根目录的解析器脚本。OpenClaw 会在启动或重新加载时，将其具体化为当前 Node 可执行文件和插件内脚本的绝对路径。`--require`、`--import`、`--loader`、`--env-file`、`--eval` 和 `--print` 等 Node 选项不属于清单预设契约。需要非 Node 命令的操作员可以直接配置独立的手动 Exec 提供商。 对于清单预设，OpenClaw 会根据插件根目录派生 `trustedDirs`；对于 `${node}` 预设，还会包含当前 Node 可执行文件所在目录。清单中编写的 `trustedDirs` 会被忽略。`timeoutMs`、`noOutputTimeoutMs`、`maxOutputBytes`、`jsonOnly`、`env`、`passEnv` 和 `allowInsecurePath` 等其他 Exec 提供商选项会原样传递给常规 SecretRef Exec 提供商配置。 ## `modelPricing` 参考 当提供商需要在运行时加载之前控制控制平面的定价行为时，请使用 `modelPricing`。Gateway 网关定价缓存无需导入提供商运行时代码即可读取此元数据。 ```json { "providers": ["ollama", "openrouter"], "modelPricing": { "providers": { "ollama": { "external": false }, "openrouter": { "openRouter": { "passthroughProviderModel": true }, "liteLLM": false } } } } ``` 提供商字段： | 字段 | 类型 | 含义 | | ------------ | ----------------- | --------------------------------------------------------------------------------------------- | | `external` | `boolean` | 对不应获取 OpenRouter 或 LiteLLM 定价的本地或自托管提供商设为 `false`。 | | `openRouter` | `false \| object` | OpenRouter 定价查询映射。`false` 会为此提供商禁用 OpenRouter 查询。 | | `liteLLM` | `false \| object` | LiteLLM 定价查询映射。`false` 会为此提供商禁用 LiteLLM 查询。 | 来源字段： | 字段 | 类型 | 含义 | | -------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------ | | `provider` | `string` | 当外部目录提供商 ID 与 OpenClaw 提供商 ID 不同时使用，例如 `zai` 提供商对应的 `z-ai`。 | | `passthroughProviderModel` | `boolean` | 将包含斜杠的模型 ID 视为嵌套的提供商/模型引用，适用于 OpenRouter 等代理提供商。 | | `modelIdTransforms` | `"version-dots"[]` | 额外的外部目录模型 ID 变体。`version-dots` 会尝试 `claude-opus-4.6` 这类带点号的版本 ID。 | ### OpenClaw 提供商索引 OpenClaw 提供商索引是由 OpenClaw 管理的预览元数据，适用于插件可能尚未安装的提供商。它不属于插件清单。插件清单仍是已安装插件的权威来源。提供商索引是一项内部回退契约；当提供商插件未安装时，未来的可安装提供商界面和安装前模型选择器界面将使用它。 目录权威顺序： 1. 用户配置。 2. 已安装插件清单中的 `modelCatalog`。 3. 通过显式刷新生成的模型目录缓存。 4. OpenClaw 提供商索引预览行。 提供商索引不得包含密钥、启用状态、运行时钩子或实时的账户特定模型数据。其预览目录使用与插件清单相同的 `modelCatalog` 提供商行结构，但应仅包含稳定的显示元数据；除非有意让 `api`、`baseUrl`、定价或兼容性标志等运行时适配器字段与已安装插件清单保持一致。支持实时 `/models` 发现的提供商应通过显式模型目录缓存路径写入刷新的行，而不是让常规列表展示或新手引导调用提供商 API。 对于插件已移出核心或因其他原因尚未安装的提供商，提供商索引条目也可以携带可安装插件元数据。此元数据沿用渠道目录模式：包名称、npm 安装规范、预期完整性值以及低开销的身份验证选项标签，足以显示一个可安装的设置选项。插件安装后，其清单具有优先权，并会忽略该提供商的提供商索引条目。 `openclaw doctor --fix` 会将一小组封闭的旧版顶层清单能力键迁移到 `contracts.*`：`speechProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders` 和 `tools`。这些键以及任何其他能力列表都不再作为顶层清单字段读取；常规清单加载仅识别 `contracts` 下的这些字段。 ## 清单与 `package.json` 的区别 这两个文件承担不同的职责： | 文件 | 用途 | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `openclaw.plugin.json` | 设备发现、配置验证、身份验证选项元数据，以及必须在插件代码运行前存在的 UI 提示 | | `package.json` | npm 元数据、依赖安装，以及用于入口点、安装门控、设置或目录元数据的 `openclaw` 块 | 如果不确定某项元数据应放在哪里，请遵循以下规则： - 如果 OpenClaw 必须在加载插件代码之前了解它，请将其放入 `openclaw.plugin.json` - 如果它涉及打包、入口文件或 npm 安装行为，请将其放入 `package.json` ### 影响设备发现的 `package.json` 字段 部分运行前插件元数据有意放在 `package.json` 的 `openclaw` 块中，而不是 `openclaw.plugin.json` 中。`openclaw.bundle` 和 `openclaw.bundle.json` 并非 OpenClaw 插件契约；原生插件必须使用 `openclaw.plugin.json` 以及下方受支持的 `package.json#openclaw` 字段。 重要示例： | 字段 | 含义 | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `openclaw.extensions` | 声明原生插件入口点。必须位于插件包目录内。 | | `openclaw.runtimeExtensions` | 声明已安装包的已构建 JavaScript 运行时入口点。必须位于插件包目录内。 | | `openclaw.setupEntry` | 轻量级的仅设置入口点，用于新手引导、延迟渠道启动，以及只读的渠道状态/SecretRef 发现。必须位于插件包目录内。 | | `openclaw.runtimeSetupEntry` | 声明已安装包的已构建 JavaScript 设置入口点。要求存在 `setupEntry`，其自身也必须存在且位于插件包目录内。 | | `openclaw.channel` | 轻量的渠道目录元数据，例如标签、文档路径、别名和选择说明文本。 | | `openclaw.channel.commands` | 在渠道运行时加载前，配置、审计和命令列表界面所使用的静态原生命令及原生技能自动默认值元数据。 | | `openclaw.channel.configuredState` | 轻量级已配置状态检查器元数据，无需加载完整渠道运行时即可回答“是否已存在仅通过环境变量完成的设置？”。 | | `openclaw.channel.persistedAuthState` | 轻量级持久化身份验证检查器元数据，无需加载完整渠道运行时即可回答“是否已有任何登录状态？”。 | | `openclaw.install.clawhubSpec` / `openclaw.install.npmSpec` / `openclaw.install.localPath` | 内置插件和外部发布插件的安装/更新提示。 | | `openclaw.install.defaultChoice` | 有多个安装来源可用时的首选安装路径。 | | `openclaw.install.minHostVersion` | 支持的最低 OpenClaw 主机版本，使用类似 `>=2026.3.22` 或 `>=2026.5.1-beta.1` 的 semver 下限。 | | `openclaw.compat.pluginApi` | 此包要求的最低 OpenClaw 插件 API 版本范围，使用类似 `>=2026.5.27` 的 semver 下限。 | | `openclaw.install.expectedIntegrity` | 预期的 npm 分发完整性字符串，例如 `sha512-...`；安装和更新流程会据此验证获取的制品。 | | `openclaw.install.allowInvalidConfigRecovery` | 配置无效时，允许采用范围有限的内置插件重新安装恢复路径。 | | `openclaw.install.requiredPlatformPackages` | 当锁文件中的平台约束与当前主机匹配时必须实际安装的 npm 包别名。 | | `openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListen` | 允许在开始监听前加载设置运行时的渠道界面，然后将完整的已配置渠道插件延迟到监听后的激活阶段。 | 清单元数据决定运行时加载前，新手引导中会显示哪些提供商/渠道/设置选项。`package.json#openclaw.install` 告诉新手引导，当用户选择其中某个选项时应如何获取或启用该插件。不要将安装提示移入 `openclaw.plugin.json`。 对于非内置插件来源，安装和清单注册表加载期间会强制执行 `openclaw.install.minHostVersion`。无效值会被拒绝；较新但有效的值会使较旧主机跳过外部插件。内置源插件视为与主机检出版本保持一致。 `openclaw.install.requiredPlatformPackages` 适用于通过可选的平台特定别名提供必需原生二进制文件的 npm 包。请列出每个受支持平台别名对应的裸 npm 包名。在 npm 安装期间，OpenClaw 仅验证锁文件约束与当前主机匹配的已声明别名。如果 npm 报告成功但遗漏了该别名，OpenClaw 会使用全新缓存重试一次；如果别名仍然缺失，则回滚安装。 对于非内置插件来源，包安装期间会强制执行 `openclaw.compat.pluginApi`。使用它指定构建该包时所依赖的 OpenClaw 插件 SDK/运行时 API 下限。当插件包需要较新的 API，但仍为其他流程保留较低的安装提示时，它可以比 `minHostVersion` 更严格。默认情况下，OpenClaw 官方版本同步会将现有官方插件的 API 下限提升到对应的 OpenClaw 发布版本，但如果插件包有意支持较旧主机，仅发布插件的版本可以保留较低下限。不要仅将包版本用作兼容性契约。`peerDependencies.openclaw` 仍是 npm 包元数据；OpenClaw 使用 `openclaw.compat.pluginApi` 契约作出安装兼容性决策。 如果插件已发布到 ClawHub，官方按需安装元数据应使用 `clawhubSpec`；新手引导会将其视为首选远程来源，并在安装后记录 ClawHub 制品信息。对于尚未迁移到 ClawHub 的包，`npmSpec` 仍作为兼容性回退方案。 npm 精确版本固定已由 `npmSpec` 承担，例如 `"npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3"`。官方外部目录条目应将精确规格与 `expectedIntegrity` 配对，以便当获取的 npm 制品不再与固定版本匹配时，更新流程以失败关闭方式终止。为保持兼容性，交互式新手引导仍提供可信注册表中的 npm 规格，包括裸包名和 dist-tag。目录诊断可以区分精确来源、浮动来源、完整性固定来源、缺少完整性的来源、包名不匹配来源和无效默认选项来源。当存在 `expectedIntegrity`，但没有可供其固定的有效 npm 来源时，诊断也会发出警告。存在 `expectedIntegrity` 时，安装/更新流程会强制执行它；省略时，则记录注册表解析结果，但不设置完整性固定值。 当状态、渠道列表或 SecretRef 扫描需要在不加载完整运行时的情况下识别已配置账户时，渠道插件应提供 `openclaw.setupEntry`。设置入口应公开渠道元数据，以及可安全用于设置流程的配置、状态和机密信息适配器；网络客户端、Gateway 网关监听器和传输运行时应保留在主扩展入口点中。 运行时入口点字段不会覆盖源入口点字段的包边界检查。例如，`openclaw.runtimeExtensions` 无法使逃逸到包目录之外的 `openclaw.extensions` 路径变为可加载。 `openclaw.install.allowInvalidConfigRecovery` 的适用范围有意保持狭窄。它不会让任意损坏的配置变得可安装。目前，它仅允许安装流程从特定的陈旧内置插件升级故障中恢复，例如缺少内置插件路径，或存在属于同一内置插件的陈旧 `channels.` 条目。无关的配置错误仍会阻止安装，并引导操作员运行 `openclaw doctor --fix`。 `openclaw.channel.persistedAuthState` 是用于微型检查器模块的包元数据： ```json { "openclaw": { "channel": { "id": "whatsapp", "persistedAuthState": { "specifier": "./auth-presence", "exportName": "hasAnyWhatsAppAuth" } } } } ``` 当设置、Doctor、状态或只读存在性流程需要在完整渠道插件加载前进行低开销的是/否身份验证探测时，请使用它。持久化身份验证状态不等同于已配置渠道状态：不要使用此元数据自动启用插件、修复运行时依赖项，或决定是否应加载渠道运行时。目标导出应是一个仅读取持久化状态的小型函数；不要通过完整的渠道运行时桶形导出文件调用它。 `openclaw.channel.configuredState` 对低开销的仅环境变量已配置检查采用相同结构： ```json { "openclaw": { "channel": { "id": "telegram", "configuredState": { "specifier": "./configured-state", "exportName": "hasTelegramConfiguredState" } } } } ``` 当渠道能够根据环境变量或其他少量非运行时输入判断已配置状态时，请使用它。如果检查需要完整的配置解析或实际渠道运行时，请改为将该逻辑保留在插件的 `config.hasConfiguredState` 钩子中。 ## 设备发现优先级（重复的插件 ID） OpenClaw 从三个根目录发现插件，并按以下顺序检查：随 OpenClaw 一起提供的内置插件、全局安装根目录（`~/.openclaw/extensions`）和当前工作区根目录（`/.openclaw/extensions`），此外还包括所有显式的 `plugins.load.paths` 条目。 如果两个发现结果具有相同的 `id`，则仅保留**优先级最高**的清单；优先级较低的重复项会被丢弃，而不会与其并行加载。优先级从高到低如下： 1. **配置选定** — 在 `plugins.entries.` 中显式固定的路径 2. **与跟踪安装记录匹配的全局安装** — 通过 `openclaw plugin install`/`openclaw plugin update` 安装，且 OpenClaw 的安装跟踪能够识别为同一 ID 的插件，即使该 ID 也属于内置插件 3. **内置** — 随 OpenClaw 一起提供的插件 4. **工作区** — 相对于当前工作区发现的插件 5. 任何其他发现的候选项 影响： - 工作区或全局根目录中未经跟踪的内置插件分叉副本或陈旧副本不会遮蔽内置构建。 - 要覆盖内置插件，可以针对该 ID 运行 `openclaw plugin install`，使受跟踪的全局安装优先于内置副本；也可以通过 `plugins.entries.` 固定特定路径，使其凭借配置选定优先级胜出。 - 重复项丢弃操作会记录到日志中，以便 Doctor 和启动诊断指出被丢弃的副本。 - 在诊断中，配置选定的重复项覆盖会被表述为显式覆盖，但仍会发出警告，以确保陈旧分叉和意外遮蔽保持可见。 ## JSON Schema 要求 - **每个插件都必须提供 JSON Schema**，即使它不接受任何配置。 - 可以使用空 Schema（例如 `{ "type": "object", "additionalProperties": false }`）。 - Schema 在读取/写入配置时验证，而不是在运行时验证。 - 使用新配置键扩展或派生内置插件时，请同时更新该插件的 `openclaw.plugin.json` 中的 `configSchema`。内置插件的 Schema 采用严格模式，因此，如果在用户配置中添加 `plugins.entries..config.myNewKey`，却未将 `myNewKey` 添加到 `configSchema.properties`，则会在插件运行时加载前被拒绝。 Schema 扩展示例： ```json { "configSchema": { "type": "object", "additionalProperties": false, "properties": { "myNewKey": { "type": "string" } } } } ``` ## 验证行为 - 未知的 `channels.*` 键是**错误**，除非插件清单声明了该渠道 ID。如果同一 ID 还出现在 `plugins.allow`、`plugins.entries` 或 `plugins.installs` 中（即插件已被引用，但当前无法发现），OpenClaw 会将其降级为**警告**。 - `plugins.entries.`、`plugins.allow` 和 `plugins.deny` 引用未知插件 ID 时会产生**警告**（“已忽略过时的配置条目”），而不是错误，因此升级以及插件被删除或重命名不会阻止 Gateway 网关启动。 - `plugins.slots.memory` 引用未知插件 ID 时是**错误**，但已知的官方外部插件 `memory-lancedb` 除外，对它只会发出警告。 - 如果插件已安装，但其清单或 Schema 损坏或缺失，验证将失败，并且 Doctor 会报告该插件错误。 - 如果插件配置存在，但插件已被**禁用**，配置会保留，并且 Doctor 和日志中会显示**警告**。 有关完整的 `plugins.*` Schema，请参阅[配置参考](/zh-CN/gateway/configuration)。 ## 注意事项 - **原生 OpenClaw 插件必须提供清单**，包括从本地文件系统加载的插件。运行时仍会单独加载插件模块；清单仅用于设备发现和验证。 - 原生清单使用 JSON5 解析，因此只要最终值仍是对象，就允许使用注释、尾随逗号和不带引号的键。 - 清单加载器只会读取已记录的清单字段。请避免使用自定义顶层键。 - 插件不需要 `channels`、`providers`、`cliBackends` 或 `skills` 时，可以省略这些字段。 - `providerCatalogEntry` 必须保持轻量，不应导入大范围的运行时代码；请将其用于静态提供商目录元数据或范围明确的设备发现描述符，而不是请求时执行。 - 互斥插件类型通过 `plugins.slots.*` 选择：通过 `plugins.slots.memory` 选择 `kind: "memory"`（默认为 `memory-core`），通过 `plugins.slots.contextEngine` 选择 `kind: "context-engine"`（默认为 `legacy`）。 - 请在此清单中声明互斥插件类型。运行时入口的 `OpenClawPluginDefinition.kind` 已弃用，仅作为旧版插件的兼容性回退保留。 - 环境变量元数据（`setup.providers[].envVars`、已弃用的 `providerAuthEnvVars` 和 `channelEnvVars`）仅用于声明。状态、审计、cron 投递验证及其他只读界面在将环境变量视为已配置之前，仍会应用插件信任和有效激活策略。 - 对于需要提供商代码的运行时向导元数据，请参阅[提供商运行时钩子](/zh-CN/plugins/architecture-internals#provider-runtime-hooks)。 - 如果你的插件依赖原生模块，请记录构建步骤以及包管理器的所有允许列表要求（例如 pnpm `allow-build-scripts` + `pnpm rebuild `）。 ## 相关内容 插件入门指南。 内部架构和能力模型。 插件 SDK 参考和子路径导入。