Skip to main content
插件 SDK 包含精简的公共子路径,以及 openclaw/plugin-sdk/ 下仅供仓库内部使用的内置 辅助模块。本页列出两者,并明确标注 私有本地条目。以下三个文件定义了该边界:
  • scripts/lib/plugin-sdk-entrypoints.json:由构建系统编译的 维护中入口点清单。
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json:从有类型、有文档的 SDK 中 排除的内部子路径。生产条目仍以仅含 JavaScript 的宿主运行时导出形式提供, 供单独发布的官方插件使用;仅测试条目保持不导出。
  • src/plugin-sdk/entrypoints.ts:弃用子路径、保留的内置辅助模块、 受支持的内置门面,以及插件所有的公共表面的分类元数据。
维护者使用 pnpm plugin-sdk:surface 审核公共导出数量,并使用 pnpm plugins:boundary-report:summary 审核活跃的保留辅助模块子路径; 未使用的保留辅助模块导出会导致 CI 报告失败,而不是作为休眠的兼容性债务 保留在公共 SDK 中。 有关插件创作指南,请参阅插件 SDK 概览

插件入口

兼容性和私有本地辅助模块

仅较晚窗口期的弃用子路径仍保持导出。2026 年 7 月的别名和 未使用的子路径已被删除,而仅供内置使用的辅助模块已从 公共软件包中移除,并在下方标记为私有本地。维护中的列表为 scripts/lib/plugin-sdk-deprecated-public-subpaths.json;CI 会拒绝内置 plugin-sdk/text-runtime 仅用于兼容,而 plugin-sdk/zod 是 兼容性再导出:请直接从 zod 导入 zod。宽泛的领域 桶文件 plugin-sdk/agent-runtimeplugin-sdk/channel-lifecycleplugin-sdk/conversation-runtimeplugin-sdk/hook-runtimeplugin-sdk/media-runtimeplugin-sdk/plugin-runtimeplugin-sdk/security-runtime 同样已弃用,请改用聚焦的 子路径。 OpenClaw 基于 Vitest 的测试辅助模块子路径仅供仓库本地使用,不再是 软件包导出:agent-runtime-test-contractschannel-contract-testingchannel-target-testingchannel-test-helpersplugin-state-test-runtimeplugin-test-apiplugin-test-contractsplugin-test-runtimeprovider-http-test-mocksprovider-test-contractsreply-payload-testingsqlite-runtime-testingtest-envtest-fixturestest-livetest-live-authtest-media-generationtest-media-understandingtest-node-mockstesting。私有内置辅助模块表面 ssrf-runtime-internalcodex-native-task-runtime 也仅供仓库本地 使用。

内置插件辅助模块子路径

经过 2026 年 7 月的清理后,仅供内置使用的辅助模块为私有本地模块。软件包契约护栏会阻止跨所有者导入。src/plugin-sdk/entrypoints.ts 单独跟踪仍保持公共的受支持内置门面,即由对应内置插件支持的 SDK 入口点,直至通用契约取代 plugin-sdk/qa-runner-runtimeplugin-sdk/telegram-account; 新代码不应再使用;请参阅下方各行的说明。
较晚窗口期的渠道兼容性子路径仅在其注册表日期内保持公共。 2026 年 7 月的别名(例如私信访问、回复选项、配对 路径和渠道运行时分支)已被移除;仅供内置使用的辅助模块 为私有本地模块。
提供商用量快照通常会报告一个或多个配额 windows,每个都包含 标签、已用百分比和可选的重置时间。对于公开余额或 账户状态文本而非可重置配额窗口的提供商,应返回 summary 并将 windows 数组置空,而不是编造百分比。 OpenClaw 会在状态输出中显示该摘要文本;仅当用量端点 失败或未返回可用的用量数据时,才使用 error
保留的内置辅助 SDK 子路径是供内置插件代码使用的精简所有者专用表面。SDK 清单会跟踪这些子路径,以确保软件包构建和别名映射保持确定性,但它们并不是通用的插件开发 API。新的可复用宿主契约应使用通用 SDK 子路径,例如 plugin-sdk/gateway-runtimeplugin-sdk/ssrf-runtime

相关内容