Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenClaw 已从宽泛的向后兼容层迁移到现代插件架构,使用聚焦且有文档说明的导入。如果你的插件是在新架构之前构建的,本指南可帮助你迁移。

有哪些变化

旧插件系统提供了两个完全开放的表面,让插件可以从单一入口点导入它们需要的任何内容:
  • openclaw/plugin-sdk/compat - 一个单一导入,会重新导出数十个辅助工具。它的引入是为了在新插件架构构建期间,让较旧的基于钩子的插件继续工作。
  • openclaw/plugin-sdk/infra-runtime - 一个宽泛的运行时辅助工具桶,混合了系统事件、Heartbeat 状态、投递队列、fetch/proxy 辅助工具、文件辅助工具、审批类型和无关实用工具。
  • openclaw/plugin-sdk/config-runtime - 一个宽泛的配置兼容桶,在迁移窗口期间仍携带已弃用的直接加载/写入辅助工具。
  • openclaw/extension-api - 一个桥接层,让插件可以直接访问主机侧辅助工具,例如嵌入式 Agent 运行器。
  • api.registerEmbeddedExtensionFactory(...) - 一个已移除的仅限 Pi 的内置插件钩子,可观察嵌入式运行器事件,例如 tool_result
这些宽泛的导入表面现在已弃用。它们在运行时仍然可用,但新插件不得使用它们,现有插件也应在下一个主要版本移除它们之前完成迁移。仅限 Pi 的嵌入式插件工厂注册 API 已被移除;请改用工具结果中间件。 OpenClaw 不会在引入替代方案的同一次变更中移除或重新解释已记录的插件行为。破坏性契约变更必须先经过兼容适配器、诊断、文档和弃用窗口。这适用于 SDK 导入、清单字段、设置 API、钩子和运行时注册行为。
向后兼容层将在未来的主要版本中移除。届时,仍从这些表面导入的插件将会中断。仅限 Pi 的嵌入式插件工厂注册已经不再加载。

为什么做出此变更

旧方法会导致问题:
  • 启动缓慢 - 导入一个辅助工具会加载数十个无关模块
  • 循环依赖 - 宽泛的重新导出很容易产生导入循环
  • API 表面不清晰 - 无法判断哪些导出是稳定的,哪些是内部的
现代插件 SDK 修复了这一点:每个导入路径(openclaw/plugin-sdk/\<subpath\>)都是一个小型、自包含的模块,具有清晰用途和已记录的契约。 用于内置渠道的旧版提供商便捷衔接点也已移除。带渠道品牌的辅助衔接点是私有单仓库快捷方式,不是稳定的插件契约。请改用窄范围的通用 SDK 子路径。在内置插件工作区内,将提供商所有的辅助工具保留在该插件自己的 api.tsruntime-api.ts 中。 当前内置提供商示例:
  • Anthropic 将 Claude 专用流辅助工具保留在它自己的 api.ts / contract-api.ts 衔接点中
  • OpenAI 将提供商构建器、默认模型辅助工具和实时提供商构建器保留在它自己的 api.ts
  • OpenRouter 将提供商构建器和新手引导/配置辅助工具保留在它自己的 api.ts

Talk 和实时语音迁移计划

实时语音、电话、会议和浏览器 Talk 代码正在从表面本地的轮次记账迁移到由 openclaw/plugin-sdk/realtime-voice 导出的共享 Talk 会话控制器。新的控制器负责通用 Talk 事件信封、活动轮次状态、采集状态、输出音频状态、最近事件历史和过期轮次拒绝。提供商插件应继续负责厂商专用实时会话;表面插件应继续负责采集、播放、电话和会议差异。 这次 Talk 迁移有意采用破坏性清理:
  1. 将共享控制器/运行时原语保留在 plugin-sdk/realtime-voice 中。
  2. 将内置表面迁移到共享控制器:浏览器中继、托管房间交接、语音通话实时、语音通话流式 STT、Google Meet 实时和原生按键通话。
  3. 用最终的 talk.session.*talk.client.* API 替换旧 Talk RPC 系列。
  4. 在 Gateway 网关 hello-ok.features.events 中公开一个实时 Talk 事件渠道:talk.event
  5. 删除旧的实时 HTTP 端点和任何请求时指令覆盖路径。
新代码不应直接调用 createTalkEventSequencer(...),除非它正在实现低层适配器或测试夹具。优先使用共享控制器,这样没有轮次 id 就无法发出轮次范围事件,过期的 turnEnd / turnCancel 调用无法清除较新的活动轮次,并且输出音频生命周期事件可在电话、会议、浏览器中继、托管房间交接和原生 Talk 客户端之间保持一致。 目标公共 API 形态如下:
// Gateway-owned Talk session API.
await gateway.request("talk.session.create", {
  mode: "realtime",
  transport: "gateway-relay",
  brain: "agent-consult",
  sessionKey: "main",
});
await gateway.request("talk.session.appendAudio", { sessionId, audioBase64 });
await gateway.request("talk.session.cancelOutput", { sessionId, reason: "barge-in" });
await gateway.request("talk.session.submitToolResult", {
  sessionId,
  callId,
  result: { status: "working" },
  options: { willContinue: true },
});
await gateway.request("talk.session.submitToolResult", {
  sessionId,
  callId,
  result: { status: "already_delivered" },
  options: { suppressResponse: true },
});
await gateway.request("talk.session.submitToolResult", { sessionId, callId, result });
await gateway.request("talk.session.close", { sessionId });

// Client-owned provider session API.
await gateway.request("talk.client.create", {
  mode: "realtime",
  transport: "webrtc",
  brain: "agent-consult",
  sessionKey: "main",
});
await gateway.request("talk.client.toolCall", { sessionKey, callId, name, args });
浏览器所有的 WebRTC/提供商 websocket 会话使用 talk.client.create,因为浏览器拥有提供商协商和媒体传输,而 Gateway 网关拥有凭证、指令和工具策略。talk.session.* 是由 Gateway 网关管理的通用表面,适用于 gateway-relay 实时、gateway-relay 转录和 managed-room 原生 STT/TTS 会话。 将实时选择器放在 talk.provider / talk.providers 旁边的旧版配置,应使用 openclaw doctor --fix 修复;运行时 Talk 不会将语音/TTS 提供商配置重新解释为实时提供商配置。 受支持的 talk.session.create 组合有意保持很小:
模式传输大脑所有者说明
realtimegateway-relayagent-consultGateway 网关通过 Gateway 网关桥接的全双工提供商音频;工具调用通过 agent-consult 工具路由。
transcriptiongateway-relaynoneGateway 网关仅流式 STT;调用方发送输入音频并接收转录事件。
stt-ttsmanaged-roomagent-consult原生/客户端房间按键通话和对讲式房间,其中客户端拥有采集/播放,Gateway 网关拥有轮次状态。
stt-ttsmanaged-roomdirect-tools原生/客户端房间面向受信任第一方表面的仅管理员房间模式,可直接执行 Gateway 网关工具动作。
已移除的方法映射:
talk.realtime.sessiontalk.client.create
talk.realtime.toolCalltalk.client.toolCall
talk.realtime.relayAudiotalk.session.appendAudio
talk.realtime.relayCanceltalk.session.cancelOutputtalk.session.cancelTurn
talk.realtime.relayToolResulttalk.session.submitToolResult
talk.realtime.relayStoptalk.session.close
talk.transcription.sessiontalk.session.create({ mode: "transcription" })
talk.transcription.relayAudiotalk.session.appendAudio
talk.transcription.relayCanceltalk.session.cancelTurn
talk.transcription.relayStoptalk.session.close
talk.handoff.createtalk.session.create({ transport: "managed-room" })
talk.handoff.jointalk.session.join
talk.handoff.revoketalk.session.close
统一控制词汇也有意保持窄范围:
方法适用于契约
talk.session.appendAudiorealtime/gateway-relaytranscription/gateway-relay向由同一 Gateway 网关连接拥有的提供商会话追加一个 base64 PCM 音频块。
talk.session.startTurnstt-tts/managed-room启动一个托管房间用户轮次。
talk.session.endTurnstt-tts/managed-room在过期轮次验证后结束活动轮次。
talk.session.cancelTurn所有 Gateway 网关所有的会话取消某个轮次的活动采集/提供商/Agent/TTS 工作。
talk.session.cancelOutputrealtime/gateway-relay停止助手音频输出,但不一定结束用户轮次。
talk.session.submitToolResultrealtime/gateway-relay完成由中继发出的提供商工具调用;传入 options.willContinue 表示中间输出,或传入 options.suppressResponse 以在不生成另一条助手响应的情况下满足该调用。
talk.session.close所有统一会话停止中继会话或撤销托管房间状态,然后忘记统一会话 id。
不要在核心中引入提供商或平台特殊情况来实现这项工作。 核心负责 Talk 会话语义。提供商插件负责厂商会话设置。 语音通话和 Google Meet 负责电话/会议适配器。浏览器和原生 应用负责设备采集/播放 UX。

兼容性策略

对于外部插件,兼容性工作按此顺序进行:
  1. 添加新契约
  2. 保持旧行为通过兼容性适配器连接
  3. 发出诊断或警告,指出旧路径和替代方案
  4. 在测试中覆盖两条路径
  5. 记录弃用和迁移路径
  6. 仅在已公告的迁移窗口后移除,通常在主版本发布中移除
维护者可以用 pnpm plugins:boundary-report 审计当前迁移队列。使用 pnpm plugins:boundary-report:summary 获取 紧凑计数,使用 --owner <id> 针对单个插件或兼容性所有者,并在 CI 门禁需要因到期的 兼容性记录、跨所有者保留 SDK 导入或未使用的保留 SDK 子路径而失败时使用 pnpm plugins:boundary-report:ci。报告会按移除日期分组已弃用的 兼容性记录,统计本地代码/文档引用,暴露跨所有者保留 SDK 导入,并总结私有 memory-host SDK 桥接,使兼容性清理保持显式,而不是依赖临时搜索。保留 SDK 子路径必须有已跟踪的所有者用法; 未使用的保留辅助导出应从公共 SDK 中移除。 如果某个清单字段仍被接受,插件作者可以继续使用它,直到 文档和诊断另行说明。新代码应优先使用已记录的 替代项,但现有插件不应在普通次版本 发布期间中断。

如何迁移

1

Migrate runtime config load/write helpers

内置插件应停止直接调用 api.runtime.config.loadConfig()api.runtime.config.writeConfigFile(...)。优先使用 已经传入活跃调用路径的配置。需要当前进程快照的长生命周期处理器可以使用 api.runtime.config.current()。长生命周期 agent 工具应在 execute 内使用工具上下文的 ctx.getRuntimeConfig(),这样在配置写入前创建的工具仍能看到刷新的 运行时配置。配置写入必须通过事务式辅助工具,并选择一个 写入后策略:
await api.runtime.config.mutateConfigFile({
  afterWrite: { mode: "auto" },
  mutate(draft) {
    draft.plugins ??= {};
  },
});
当调用方知道更改需要干净重启 Gateway 网关时,使用 afterWrite: { mode: "restart", reason: "..." }; 仅当调用方负责后续处理,并且有意抑制重载规划器时,才使用 afterWrite: { mode: "none", reason: "..." }。 变更结果包含一个带类型的 followUp 摘要,用于测试和日志; Gateway 网关仍负责应用或安排重启。 loadConfigwriteConfigFile 在迁移窗口期间仍作为已弃用的兼容性 辅助工具保留给外部插件,并使用 runtime-config-load-write 兼容性代码警告一次。内置插件和仓库 运行时代码受 pnpm check:deprecated-api-usagepnpm check:no-runtime-action-load-config 中的扫描器护栏保护:新的生产插件用法 会直接失败,直接配置写入会失败,Gateway 网关服务器方法必须使用 请求运行时快照,运行时渠道发送/action/client 辅助工具 必须从其边界接收配置,并且长生命周期运行时模块 不允许任何环境式 loadConfig() 调用。新插件代码还应避免导入宽泛的 openclaw/plugin-sdk/config-runtime 兼容性桶。请使用与任务匹配的窄 SDK 子路径:
需求导入
配置类型,例如 OpenClawConfigopenclaw/plugin-sdk/config-contracts
已加载配置断言和插件入口配置查找openclaw/plugin-sdk/plugin-config-runtime
当前运行时快照读取openclaw/plugin-sdk/runtime-config-snapshot
配置写入openclaw/plugin-sdk/config-mutation
会话存储辅助工具openclaw/plugin-sdk/session-store-runtime
Markdown 表格配置openclaw/plugin-sdk/markdown-table-runtime
群组策略运行时辅助工具openclaw/plugin-sdk/runtime-group-policy
密钥输入解析openclaw/plugin-sdk/secret-input-runtime
模型/会话覆盖openclaw/plugin-sdk/model-session-runtime
内置插件及其测试会被扫描器保护,防止使用宽泛的 桶,因此导入和 mock 会保持局部化,只覆盖它们所需的行为。宽泛的 桶仍为外部兼容性存在,但新代码不应 依赖它。
2

Migrate Pi tool-result extensions to middleware

内置插件必须将仅限 Pi 的 api.registerEmbeddedExtensionFactory(...) 工具结果处理器替换为 运行时中立的中间件。
// Pi and Codex runtime dynamic tools
api.registerAgentToolResultMiddleware(async (event) => {
  return compactToolResult(event);
}, {
  runtimes: ["pi", "codex"],
});
同时更新插件清单:
{
  "contracts": {
    "agentToolResultMiddleware": ["pi", "codex"]
  }
}
外部插件不能注册工具结果中间件,因为它可以 在模型看到高信任工具输出前改写它。
3

Migrate approval-native handlers to capability facts

支持审批的渠道插件现在通过 approvalCapability.nativeRuntime 加上共享运行时上下文注册表暴露原生审批行为。关键变更:
  • approvalCapability.handler.loadRuntime(...) 替换为 approvalCapability.nativeRuntime
  • 将审批专用认证/投递从旧版 plugin.auth / plugin.approvals 接线迁移到 approvalCapability
  • ChannelPlugin.approvals 已从公共渠道插件 契约中移除;将投递/native/render 字段迁移到 approvalCapability
  • plugin.auth 仅保留用于渠道登录/登出流程;核心不再读取其中的审批认证 钩子
  • 通过 openclaw/plugin-sdk/channel-runtime-context 注册渠道拥有的运行时对象,例如客户端、令牌或 Bolt 应用
  • 不要从原生审批处理器发送插件拥有的重路由通知; 核心现在根据实际投递结果负责路由到别处的通知
  • channelRuntime 传入 createChannelManager(...) 时,请提供真实的 createPluginRuntime().channel 表面。部分 stub 会被拒绝。
请参阅 /plugins/sdk-channel-plugins 了解当前审批能力 布局。
4

Audit Windows wrapper fallback behavior

如果你的插件使用 openclaw/plugin-sdk/windows-spawn,未解析的 Windows .cmd/.bat 包装器现在会默认失败关闭,除非你显式传入 allowShellFallback: true
// Before
const program = applyWindowsSpawnProgramPolicy({ candidate });

// After
const program = applyWindowsSpawnProgramPolicy({
  candidate,
  // Only set this for trusted compatibility callers that intentionally
  // accept shell-mediated fallback.
  allowShellFallback: true,
});
如果你的调用方并非有意依赖 shell 回退,请不要设置 allowShellFallback,而是处理抛出的错误。
5

Find deprecated imports

在你的插件中搜索来自任一已弃用表面的导入:
grep -r "plugin-sdk/compat" my-plugin/
grep -r "plugin-sdk/infra-runtime" my-plugin/
grep -r "plugin-sdk/config-runtime" my-plugin/
grep -r "openclaw/extension-api" my-plugin/
6

Replace with focused imports

旧表面的每个导出都映射到一个特定的现代导入路径:
// Before (deprecated backwards-compatibility layer)
import {
  createChannelReplyPipeline,
  createPluginRuntimeStore,
  resolveControlCommandGate,
} from "openclaw/plugin-sdk/compat";

// After (modern focused imports)
import { createChannelReplyPipeline } from "openclaw/plugin-sdk/channel-reply-pipeline";
import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store";
import { resolveControlCommandGate } from "openclaw/plugin-sdk/command-auth";
对于宿主侧辅助工具,请使用注入的插件运行时,而不是 直接导入:
// Before (deprecated extension-api bridge)
import { runEmbeddedPiAgent } from "openclaw/extension-api";
const result = await runEmbeddedPiAgent({ sessionId, prompt });

// After (injected runtime)
const result = await api.runtime.agent.runEmbeddedPiAgent({ sessionId, prompt });
同样的模式适用于其他旧版桥接辅助工具:
旧导入现代等价项
resolveAgentDirapi.runtime.agent.resolveAgentDir
resolveAgentWorkspaceDirapi.runtime.agent.resolveAgentWorkspaceDir
resolveAgentIdentityapi.runtime.agent.resolveAgentIdentity
resolveThinkingDefaultapi.runtime.agent.resolveThinkingDefault
resolveAgentTimeoutMsapi.runtime.agent.resolveAgentTimeoutMs
ensureAgentWorkspaceapi.runtime.agent.ensureAgentWorkspace
会话存储辅助工具api.runtime.agent.session.*
7

Replace broad infra-runtime imports

openclaw/plugin-sdk/infra-runtime 仍为外部 兼容性存在,但新代码应导入它实际需要的聚焦辅助表面:
需求导入
系统事件队列辅助工具openclaw/plugin-sdk/system-event-runtime
Heartbeat 唤醒、事件和可见性辅助工具openclaw/plugin-sdk/heartbeat-runtime
待处理投递队列清空openclaw/plugin-sdk/delivery-queue-runtime
渠道活动遥测openclaw/plugin-sdk/channel-activity-runtime
内存中去重缓存openclaw/plugin-sdk/dedupe-runtime
安全本地文件/媒体路径辅助工具openclaw/plugin-sdk/file-access-runtime
感知 dispatcher 的 fetchopenclaw/plugin-sdk/runtime-fetch
代理和受保护 fetch 辅助工具openclaw/plugin-sdk/fetch-runtime
SSRF dispatcher 策略类型openclaw/plugin-sdk/ssrf-dispatcher
审批请求/解决类型openclaw/plugin-sdk/approval-runtime
审批回复 payload 和命令辅助工具openclaw/plugin-sdk/approval-reply-runtime
错误格式化辅助工具openclaw/plugin-sdk/error-runtime
传输就绪等待openclaw/plugin-sdk/transport-ready-runtime
安全令牌辅助工具openclaw/plugin-sdk/secure-random-runtime
有界异步任务并发openclaw/plugin-sdk/concurrency-runtime
数值强制转换openclaw/plugin-sdk/number-runtime
进程本地异步锁openclaw/plugin-sdk/async-lock-runtime
文件锁openclaw/plugin-sdk/file-lock
内置插件会被扫描器保护,防止使用 infra-runtime,因此仓库代码 不能回退到宽泛桶。
8

Migrate channel route helpers

新的渠道路由代码应使用 openclaw/plugin-sdk/channel-route。 较旧的 route-key 和 comparable-target 名称在迁移窗口期间仍作为兼容性 别名保留,但新插件应使用直接描述行为的 route 名称:
旧版辅助函数现代辅助函数
channelRouteIdentityKey(...)channelRouteDedupeKey(...)
channelRouteKey(...)channelRouteCompactKey(...)
ComparableChannelTargetChannelRouteParsedTarget
resolveComparableTargetForChannel(...)resolveRouteTargetForChannel(...)
resolveComparableTargetForLoadedChannel(...)resolveRouteTargetForLoadedChannel(...)
comparableChannelTargetsMatch(...)channelRouteTargetsMatchExact(...)
comparableChannelTargetsShareRoute(...)channelRouteTargetsShareConversation(...)
现代路由辅助函数会在原生审批、回复抑制、入站去重、 cron 投递和会话路由中一致地规范化 { channel, to, accountId, threadId }。 如果你的插件拥有自定义目标语法,请使用 resolveChannelRouteTargetWithParser(...) 将该解析器适配到相同的路由目标契约中。
9

Build and test

pnpm build
pnpm test -- my-plugin/

导入路径参考

导入路径用途关键导出
plugin-sdk/plugin-entry标准插件入口辅助工具definePluginEntry
plugin-sdk/core用于渠道入口定义/构建器的旧版总括重新导出defineChannelPluginEntry, createChatChannelPlugin
plugin-sdk/config-schema根配置 schema 导出OpenClawSchema
plugin-sdk/provider-entry单提供商入口辅助工具defineSingleProviderPluginEntry
plugin-sdk/channel-core聚焦的渠道入口定义和构建器defineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase
plugin-sdk/setup共享设置向导辅助工具允许列表提示、设置 Status 构建器
plugin-sdk/setup-runtime设置期间运行时辅助工具导入安全的设置补丁适配器、查找备注辅助工具、promptResolvedAllowFromsplitSetupEntries、委托设置代理
plugin-sdk/setup-adapter-runtime已弃用的设置适配器别名使用 plugin-sdk/setup-runtime
plugin-sdk/setup-tools设置工具链辅助工具formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR
plugin-sdk/account-core多账号辅助工具账号列表/配置/操作门控辅助工具
plugin-sdk/account-id账号 ID 辅助工具DEFAULT_ACCOUNT_ID、账号 ID 规范化
plugin-sdk/account-resolution账号查找辅助工具账号查找 + 默认回退辅助工具
plugin-sdk/account-helpers窄范围账号辅助工具账号列表/账号操作辅助工具
plugin-sdk/channel-setup设置向导适配器createOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard,以及 DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries
plugin-sdk/channel-pairing私信配对原语createChannelPairingController
plugin-sdk/channel-reply-pipeline回复前缀、正在输入状态和来源投递接线createChannelReplyPipeline, resolveChannelSourceReplyDeliveryMode
plugin-sdk/channel-config-helpers配置适配器工厂和私信访问辅助工具createHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases
plugin-sdk/channel-config-schema配置 schema 构建器共享渠道配置 schema 原语和仅通用构建器
plugin-sdk/bundled-channel-config-schema内置配置 schema仅限 OpenClaw 维护的内置插件;新插件必须定义插件本地 schema
plugin-sdk/channel-config-schema-legacy已弃用的内置配置 schema仅兼容别名;对维护中的内置插件使用 plugin-sdk/bundled-channel-config-schema
plugin-sdk/telegram-command-configTelegram 命令配置辅助工具命令名称规范化、描述裁剪、重复/冲突校验
plugin-sdk/channel-policy群组/私信策略解析resolveChannelGroupRequireMention
plugin-sdk/channel-lifecycle账号 Status 和草稿流生命周期辅助工具createAccountStatusSink、草稿预览最终化辅助工具
plugin-sdk/inbound-envelope入站信封辅助工具共享路由 + 信封构建器辅助工具
plugin-sdk/inbound-reply-dispatch入站回复辅助工具共享记录并分发辅助工具
plugin-sdk/messaging-targets消息目标解析目标解析/匹配辅助工具
plugin-sdk/outbound-media出站媒体辅助工具共享出站媒体加载
plugin-sdk/outbound-send-deps出站发送依赖辅助工具不导入完整出站运行时的轻量级 resolveOutboundSendDep 查找
plugin-sdk/outbound-runtime出站运行时辅助工具出站投递、身份/发送委托、会话、格式化和载荷规划辅助工具
plugin-sdk/thread-bindings-runtime线程绑定辅助工具线程绑定生命周期和适配器辅助工具
plugin-sdk/agent-media-payload旧版媒体载荷辅助工具旧版字段布局的 Agent 媒体载荷构建器
plugin-sdk/channel-runtime已弃用的兼容性 shim仅旧版渠道运行时工具
plugin-sdk/channel-send-result发送结果类型回复结果类型
plugin-sdk/runtime-store持久化插件存储createPluginRuntimeStore
plugin-sdk/runtime宽范围运行时辅助工具运行时/日志/备份/插件安装辅助工具
plugin-sdk/runtime-env窄范围运行时 env 辅助工具日志器/运行时 env、超时、重试和退避辅助工具
plugin-sdk/plugin-runtime共享插件运行时辅助工具插件命令/钩子/http/交互式辅助工具
plugin-sdk/hook-runtime钩子流水线辅助工具共享 webhook/内部钩子流水线辅助工具
plugin-sdk/lazy-runtime懒加载运行时辅助工具createLazyRuntimeModule, createLazyRuntimeMethod, createLazyRuntimeMethodBinder, createLazyRuntimeNamedExport, createLazyRuntimeSurface
plugin-sdk/process-runtime进程辅助工具共享 exec 辅助工具
plugin-sdk/cli-runtimeCLI 运行时辅助工具命令格式化、等待、版本辅助工具
plugin-sdk/gateway-runtimeGateway 网关辅助工具Gateway 网关客户端、事件循环就绪启动辅助工具,以及渠道 Status 补丁辅助工具
plugin-sdk/config-runtime已弃用的配置兼容性 shim优先使用 config-contractsplugin-config-runtimeruntime-config-snapshotconfig-mutation
plugin-sdk/telegram-command-configTelegram 命令辅助工具当内置 Telegram 契约表面不可用时,提供回退稳定的 Telegram 命令校验辅助工具
plugin-sdk/approval-runtime审批提示辅助工具Exec/插件审批载荷、审批能力/profile 辅助工具、原生审批路由/运行时辅助工具,以及结构化审批显示路径格式化
plugin-sdk/approval-auth-runtime审批认证辅助工具审批人解析、同聊天操作认证
plugin-sdk/approval-client-runtime审批客户端辅助工具原生 exec 审批 profile/filter 辅助工具
plugin-sdk/approval-delivery-runtime审批投递辅助工具原生审批能力/投递适配器
plugin-sdk/approval-gateway-runtime审批 Gateway 网关辅助工具共享审批 Gateway 网关解析辅助工具
plugin-sdk/approval-handler-adapter-runtime审批适配器辅助工具用于热渠道入口点的轻量级原生审批适配器加载辅助工具
plugin-sdk/approval-handler-runtime审批处理器辅助工具更宽范围的审批处理器运行时辅助工具;当更窄的适配器/Gateway 网关接口足够时,优先使用它们
plugin-sdk/approval-native-runtime审批目标辅助工具原生审批目标/账号绑定辅助工具
plugin-sdk/approval-reply-runtime审批回复辅助工具Exec/插件审批回复载荷辅助工具
plugin-sdk/channel-runtime-context渠道运行时上下文辅助工具通用渠道运行时上下文注册/获取/监听辅助工具
plugin-sdk/security-runtime安全辅助工具共享信任、私信门控、根边界文件/路径辅助工具、外部内容和密钥收集辅助工具
plugin-sdk/ssrf-policySSRF 策略辅助工具主机允许列表和私有网络策略辅助工具
plugin-sdk/ssrf-runtimeSSRF 运行时辅助工具固定 dispatcher、受保护 fetch、SSRF 策略辅助工具
plugin-sdk/system-event-runtime系统事件辅助工具enqueueSystemEvent, peekSystemEventEntries
plugin-sdk/heartbeat-runtimeHeartbeat 辅助工具Heartbeat 唤醒、事件和可见性辅助工具
plugin-sdk/delivery-queue-runtime投递队列辅助工具drainPendingDeliveries
plugin-sdk/channel-activity-runtime渠道活动辅助工具recordChannelActivity
plugin-sdk/dedupe-runtime去重辅助工具内存去重缓存
plugin-sdk/file-access-runtime文件访问辅助工具安全本地文件/媒体路径辅助工具
plugin-sdk/transport-ready-runtime传输就绪辅助工具waitForTransportReady
plugin-sdk/collection-runtime有界缓存辅助工具pruneMapToMaxSize
plugin-sdk/diagnostic-runtime诊断门控辅助工具isDiagnosticFlagEnabled, isDiagnosticsEnabled
plugin-sdk/error-runtime错误格式化辅助工具formatUncaughtError, isApprovalNotFoundError、错误图辅助工具
plugin-sdk/fetch-runtime包装 fetch/代理辅助工具resolveFetch、代理辅助工具、EnvHttpProxyAgent 选项辅助工具
plugin-sdk/host-runtime主机规范化辅助工具normalizeHostname, normalizeScpRemoteHost
plugin-sdk/retry-runtime重试辅助工具RetryConfig, retryAsync、策略运行器
plugin-sdk/allow-from允许列表格式化formatAllowFromLowercase
plugin-sdk/allowlist-resolution允许列表输入映射mapAllowlistResolutionInputs
plugin-sdk/command-auth命令门控和命令表面辅助工具resolveControlCommandGate、发送者授权辅助工具、命令注册表辅助工具(包括动态参数菜单格式化)
plugin-sdk/command-status命令 Status/帮助渲染器buildCommandsMessage, buildCommandsMessagePaginated, buildHelpMessage
plugin-sdk/secret-input密钥输入解析密钥输入辅助工具
plugin-sdk/webhook-ingressWebhook 请求辅助工具Webhook 目标工具
plugin-sdk/webhook-request-guardsWebhook 正文保护辅助工具请求正文读取/限制辅助工具
plugin-sdk/reply-runtime共享回复运行时入站分发、Heartbeat、回复规划器、分块
plugin-sdk/reply-dispatch-runtime窄范围回复分发辅助工具最终化、提供商分发和对话标签辅助工具
plugin-sdk/reply-history回复历史辅助工具buildHistoryContext, buildPendingHistoryContextFromMap, recordPendingHistoryEntry, clearHistoryEntriesIfEnabled
plugin-sdk/reply-reference回复引用规划createReplyReferencePlanner
plugin-sdk/reply-chunking回复分块辅助工具文本/Markdown 分块辅助工具
plugin-sdk/session-store-runtime会话存储辅助工具存储路径 + updated-at 辅助工具
plugin-sdk/state-paths状态路径辅助工具状态和 OAuth 目录辅助工具
plugin-sdk/routing路由/会话键辅助工具resolveAgentRoute, buildAgentSessionKey, resolveDefaultAgentBoundAccountId、会话键规范化辅助工具
plugin-sdk/status-helpers渠道 Status 辅助工具渠道/账号 Status 摘要构建器、运行时状态默认值、问题元数据辅助工具
plugin-sdk/target-resolver-runtime目标解析器辅助工具共享目标解析器辅助工具
plugin-sdk/string-normalization-runtime字符串规范化辅助工具Slug/字符串规范化辅助工具
plugin-sdk/request-url请求 URL 辅助工具从类请求输入中提取字符串 URL
plugin-sdk/run-command定时命令辅助工具带规范化 stdout/stderr 的定时命令运行器
plugin-sdk/param-readers参数读取器常用工具/CLI 参数读取器
plugin-sdk/tool-payload工具载荷提取从工具结果对象中提取规范化载荷
plugin-sdk/tool-send工具发送提取从工具参数中提取规范发送目标字段
plugin-sdk/temp-path临时路径帮助工具共享的临时下载路径帮助工具
plugin-sdk/logging-core日志记录帮助工具子系统日志记录器和脱敏帮助工具
plugin-sdk/markdown-table-runtimeMarkdown 表格帮助工具Markdown 表格模式帮助工具
plugin-sdk/reply-payload消息回复类型回复载荷类型
plugin-sdk/provider-setup精选本地/自托管提供商设置帮助工具自托管提供商发现/配置帮助工具
plugin-sdk/self-hosted-provider-setup聚焦 OpenAI 兼容自托管提供商设置帮助工具相同的自托管提供商发现/配置帮助工具
plugin-sdk/provider-auth-runtime提供商运行时认证帮助工具运行时 API 密钥解析帮助工具
plugin-sdk/provider-auth-api-key提供商 API 密钥设置帮助工具API 密钥新手引导/配置文件写入帮助工具
plugin-sdk/provider-auth-result提供商认证结果帮助工具标准 OAuth 认证结果构建器
plugin-sdk/provider-selection-runtime提供商选择帮助工具已配置或自动提供商选择和原始提供商配置合并
plugin-sdk/provider-env-vars提供商环境变量帮助工具提供商认证环境变量查找帮助工具
plugin-sdk/provider-model-shared共享的提供商模型/重放帮助工具ProviderReplayFamilybuildProviderReplayFamilyHooksnormalizeModelCompat、共享重放策略构建器、提供商端点帮助工具,以及模型 ID 规范化帮助工具
plugin-sdk/provider-catalog-shared共享的提供商目录帮助工具findCatalogTemplatebuildSingleProviderApiKeyCatalogbuildManifestModelProviderConfigsupportsNativeStreamingUsageCompatapplyProviderNativeStreamingUsageCompat
plugin-sdk/provider-onboard提供商新手引导补丁新手引导配置帮助工具
plugin-sdk/provider-http提供商 HTTP 帮助工具通用提供商 HTTP/端点能力帮助工具,包括音频转录 multipart 表单帮助工具
plugin-sdk/provider-web-fetch提供商 Web-fetch 帮助工具Web-fetch 提供商注册/缓存帮助工具
plugin-sdk/provider-web-search-config-contract提供商 Web 搜索配置帮助工具面向不需要插件启用接线的提供商的窄 Web 搜索配置/凭证帮助工具
plugin-sdk/provider-web-search-contract提供商 Web 搜索契约帮助工具窄 Web 搜索配置/凭证契约帮助工具,例如 createWebSearchProviderContractFieldsenablePluginInConfigresolveProviderWebSearchPluginConfig,以及带作用域的凭证 setter/getter
plugin-sdk/provider-web-search提供商 Web 搜索帮助工具Web 搜索提供商注册/缓存/运行时帮助工具
plugin-sdk/provider-tools提供商工具/架构兼容帮助工具ProviderToolCompatFamilybuildProviderToolCompatFamilyHooks,以及 Gemini 架构清理 + 诊断
plugin-sdk/provider-usage提供商用量帮助工具fetchClaudeUsagefetchGeminiUsagefetchGithubCopilotUsage,以及其他提供商用量帮助工具
plugin-sdk/provider-stream提供商流包装器帮助工具ProviderStreamFamilybuildProviderStreamFamilyHookscomposeProviderStreamWrappers、流包装器类型,以及共享的 Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot 包装器帮助工具
plugin-sdk/provider-transport-runtime提供商传输帮助工具原生提供商传输帮助工具,例如受保护的 fetch、传输消息转换,以及可写传输事件流
plugin-sdk/keyed-async-queue有序异步队列KeyedAsyncQueue
plugin-sdk/media-runtime共享媒体帮助工具媒体获取/转换/存储帮助工具、由 ffprobe 支持的视频尺寸探测,以及媒体载荷构建器
plugin-sdk/media-generation-runtime共享媒体生成帮助工具用于图像/视频/音乐生成的共享故障转移帮助工具、候选选择,以及缺失模型消息
plugin-sdk/media-understanding媒体理解帮助工具媒体理解提供商类型,以及面向提供商的图像/音频帮助工具导出
plugin-sdk/text-runtime已弃用的宽泛文本兼容性导出使用 string-coerce-runtimetext-chunkingtext-utility-runtimelogging-core
plugin-sdk/text-chunking文本分块帮助工具出站文本分块帮助工具
plugin-sdk/speech语音帮助工具语音提供商类型,以及面向提供商的指令、注册表、验证帮助工具和 OpenAI 兼容 TTS 构建器
plugin-sdk/speech-core共享语音核心语音提供商类型、注册表、指令、规范化
plugin-sdk/realtime-transcription实时转录帮助工具提供商类型、注册表帮助工具,以及共享 WebSocket 会话帮助工具
plugin-sdk/realtime-voice实时语音帮助工具提供商类型、注册表/解析帮助工具、桥接会话帮助工具、共享智能体回话队列、转录/事件健康状态、回声抑制,以及快速上下文咨询帮助工具
plugin-sdk/image-generation图像生成帮助工具图像生成提供商类型,以及图像资产/数据 URL 帮助工具和 OpenAI 兼容图像提供商构建器
plugin-sdk/image-generation-core共享图像生成核心图像生成类型、故障转移、认证和注册表帮助工具
plugin-sdk/music-generation音乐生成帮助工具音乐生成提供商/请求/结果类型
plugin-sdk/music-generation-core共享音乐生成核心音乐生成类型、故障转移帮助工具、提供商查找,以及模型引用解析
plugin-sdk/video-generation视频生成帮助工具视频生成提供商/请求/结果类型
plugin-sdk/video-generation-core共享视频生成核心视频生成类型、故障转移帮助工具、提供商查找,以及模型引用解析
plugin-sdk/interactive-runtime交互式回复帮助工具交互式回复载荷规范化/归约
plugin-sdk/channel-config-primitives渠道配置基元窄渠道配置架构基元
plugin-sdk/channel-config-writes渠道配置写入帮助工具渠道配置写入授权帮助工具
plugin-sdk/channel-plugin-common共享渠道前导共享渠道插件前导导出
plugin-sdk/channel-status渠道状态帮助工具共享渠道状态快照/摘要帮助工具
plugin-sdk/allowlist-config-edit允许列表配置帮助工具允许列表配置编辑/读取帮助工具
plugin-sdk/group-access群组访问帮助工具共享群组访问决策帮助工具
plugin-sdk/direct-dm直接私信帮助工具共享直接私信认证/防护帮助工具
plugin-sdk/extension-shared共享扩展帮助工具被动渠道/状态和环境代理帮助基元
plugin-sdk/webhook-targetsWebhook 目标帮助工具Webhook 目标注册表和路由安装帮助工具
plugin-sdk/webhook-path已弃用的 Webhook 路径别名使用 plugin-sdk/webhook-ingress
plugin-sdk/web-media共享 Web 媒体帮助工具远程/本地媒体加载帮助工具
plugin-sdk/zod已弃用的 Zod 兼容性重新导出直接从 zod 导入 zod
plugin-sdk/memory-core内置 memory-core 帮助工具记忆管理器/配置/文件/CLI 帮助工具表面
plugin-sdk/memory-core-engine-runtime记忆引擎运行时门面记忆索引/搜索运行时门面
plugin-sdk/memory-core-host-engine-foundation记忆宿主基础引擎记忆宿主基础引擎导出
plugin-sdk/memory-core-host-engine-embeddings记忆宿主嵌入引擎记忆嵌入契约、注册表访问、本地提供商,以及通用批量/远程帮助工具;具体远程提供商位于其所属插件中
plugin-sdk/memory-core-host-engine-qmd记忆宿主 QMD 引擎记忆宿主 QMD 引擎导出
plugin-sdk/memory-core-host-engine-storage记忆宿主存储引擎记忆宿主存储引擎导出
plugin-sdk/memory-core-host-multimodal记忆宿主多模态帮助工具记忆宿主多模态帮助工具
plugin-sdk/memory-core-host-query记忆宿主查询帮助工具记忆宿主查询帮助工具
plugin-sdk/memory-core-host-secret记忆宿主机密帮助工具记忆宿主机密帮助工具
plugin-sdk/memory-core-host-events已弃用的记忆事件别名使用 plugin-sdk/memory-host-events
plugin-sdk/memory-core-host-status记忆宿主状态帮助工具记忆宿主状态帮助工具
plugin-sdk/memory-core-host-runtime-cli记忆宿主 CLI 运行时记忆宿主 CLI 运行时帮助工具
plugin-sdk/memory-core-host-runtime-core记忆宿主核心运行时记忆宿主核心运行时帮助工具
plugin-sdk/memory-core-host-runtime-files记忆宿主文件/运行时帮助工具记忆宿主文件/运行时帮助工具
plugin-sdk/memory-host-core记忆宿主核心运行时别名面向供应商中立的记忆宿主核心运行时帮助工具别名
plugin-sdk/memory-host-events记忆宿主事件日志别名面向供应商中立的记忆宿主事件日志帮助工具别名
plugin-sdk/memory-host-files已弃用的记忆文件/运行时别名使用 plugin-sdk/memory-core-host-runtime-files
plugin-sdk/memory-host-markdown托管 Markdown 帮助工具面向记忆相邻插件的共享托管 Markdown 帮助工具
plugin-sdk/memory-host-search主动记忆搜索门面延迟主动记忆搜索管理器运行时门面
plugin-sdk/memory-host-status已弃用的记忆宿主状态别名使用 plugin-sdk/memory-core-host-status
plugin-sdk/testing测试实用工具仓库本地已弃用兼容性桶形导出;使用聚焦的仓库本地测试子路径,例如 plugin-sdk/plugin-test-runtimeplugin-sdk/channel-test-helpersplugin-sdk/channel-target-testingplugin-sdk/test-envplugin-sdk/test-fixtures
此表有意只列出通用迁移子集,而不是完整 SDK 表面。编译器入口点清单位于 scripts/lib/plugin-sdk-entrypoints.json;包导出会从 公共子集生成。 预留的内置插件辅助衔接面已从公共 SDK 导出映射中退役,但明确记录的兼容性门面除外,例如已弃用的 plugin-sdk/discord shim,它是为已发布的 @openclaw/discord@2026.3.13 包保留的。所有者专属辅助函数位于 所属插件包内;共享主机行为应通过通用 SDK 契约移动,例如 plugin-sdk/gateway-runtimeplugin-sdk/security-runtimeplugin-sdk/plugin-config-runtime 使用与任务匹配的最窄导入。如果找不到导出, 请检查 src/plugin-sdk/ 中的源代码,或询问维护者哪个通用契约 应拥有它。

活跃弃用项

适用于插件 SDK、提供商契约、 运行时表面和清单的更窄弃用项。每一项现在仍可工作,但会在 未来的主版本中移除。每个条目下方的内容会把旧 API 映射到其 规范替代项。
旧(openclaw/plugin-sdk/command-authbuildCommandsMessage, buildCommandsMessagePaginated, buildHelpMessage.新(openclaw/plugin-sdk/command-status:相同签名、相同 导出,只是从更窄的子路径导入。command-auth 会将它们重新导出为兼容性桩。
// Before
import { buildHelpMessage } from "openclaw/plugin-sdk/command-auth";

// After
import { buildHelpMessage } from "openclaw/plugin-sdk/command-status";
:来自 openclaw/plugin-sdk/channel-inboundopenclaw/plugin-sdk/channel-mention-gatingresolveInboundMentionRequirement({ facts, policy })shouldDropInboundForMention(...)resolveInboundMentionDecision({ facts, policy }),返回一个 单一决策对象,而不是两个拆分调用。下游渠道插件(Slack、Discord、Matrix、MS Teams)已经切换。
openclaw/plugin-sdk/channel-runtime 是面向旧渠道插件的兼容性 shim。 不要在新代码中导入它;请使用 openclaw/plugin-sdk/channel-runtime-context 注册运行时对象。openclaw/plugin-sdk/channel-actions 中的 channelActions* 辅助函数 与原始 “actions” 渠道导出一并弃用。改为通过语义化的 presentation 表面公开能力,渠道插件声明它们渲染什么 (卡片、按钮、选择器),而不是它们接受哪些原始操作名称。
:来自 openclaw/plugin-sdk/provider-web-searchtool() 工厂。:直接在提供商插件上实现 createTool(...)。 OpenClaw 不再需要 SDK 辅助函数来注册工具包装器。
:使用 formatInboundEnvelope(...)(以及 ChannelMessageForAgent.channelEnvelope)从入站渠道消息构建扁平的纯文本提示 信封。BodyForAgent 加结构化用户上下文块。渠道插件将路由元数据 (线程、主题、回复目标、回应)作为类型化字段附加,而不是把它们 拼接进提示字符串。formatAgentEnvelope(...) 辅助函数仍支持用于合成的 面向助手的信封,但入站纯文本信封正在逐步退出。受影响区域:inbound_claimmessage_received,以及任何对 channelEnvelope 文本做后处理的自定义渠道插件。
四个发现类型别名现在是目录时代类型的薄包装:
旧别名新类型
ProviderDiscoveryOrderProviderCatalogOrder
ProviderDiscoveryContextProviderCatalogContext
ProviderDiscoveryResultProviderCatalogResult
ProviderPluginDiscoveryProviderPluginCatalog
还有旧版的 ProviderCapabilities 静态包。提供商插件 应使用显式提供商钩子,例如 buildReplayPolicynormalizeToolSchemaswrapStreamFn,而不是静态对象。
ProviderThinkingPolicy 上的三个独立钩子): isBinaryThinking(ctx)supportsXHighThinking(ctx)resolveDefaultThinkingLevel(ctx):单个 resolveThinkingProfile(ctx),返回一个 ProviderThinkingProfile,其中包含规范 id、可选 label 和 排序后的级别列表。OpenClaw 会按配置文件排名自动降级过时的已存储值。实现一个钩子,而不是三个。旧钩子在弃用窗口期间仍会工作, 但不会与配置文件结果组合。
:实现 resolveExternalOAuthProfiles(...),但不在插件清单中 声明提供商。:在插件清单中声明 contracts.externalAuthProviders并且实现 resolveExternalAuthProfiles(...)。旧的 “auth fallback” 路径会在运行时发出警告,并将被移除。
{
  "contracts": {
    "externalAuthProviders": ["anthropic", "openai"]
  }
}
清单字段:providerAuthEnvVars: { anthropic: ["ANTHROPIC_API_KEY"] }.:把相同的环境变量查找镜像到清单上的 setup.providers[].envVars。 这会把设置/Status 环境元数据合并到一个位置,并避免仅为了回答环境变量 查找而启动插件运行时。providerAuthEnvVars 会通过兼容性适配器继续受支持, 直到弃用窗口关闭。
:三个独立调用: api.registerMemoryPromptSection(...), api.registerMemoryFlushPlan(...), api.registerMemoryRuntime(...).:在 memory-state API 上进行一次调用: registerMemoryCapability(pluginId, { promptBuilder, flushPlanResolver, runtime }).相同槽位,单次注册调用。增量记忆辅助函数 (registerMemoryPromptSupplementregisterMemoryCorpusSupplementregisterMemoryEmbeddingProvider)不受影响。
仍从 src/plugins/runtime/types.ts 导出的两个旧类型别名:
SubagentReadSessionParamsSubagentGetSessionMessagesParams
SubagentReadSessionResultSubagentGetSessionMessagesResult
运行时方法 readSession 已弃用,请改用 getSessionMessages。签名相同;旧方法会转调到新方法。
runtime.tasks.flow(单数)返回实时任务流访问器。runtime.tasks.managedFlows 保留托管 TaskFlow 变更 运行时,供需要从流程创建、更新、取消或运行子任务的插件使用。 当插件只需要基于 DTO 的读取时,请使用 runtime.tasks.flows
// Before
const flow = api.runtime.tasks.flow.fromToolContext(ctx);
// After
const flow = api.runtime.tasks.managedFlows.fromToolContext(ctx);
上文 “How to migrate → Migrate Pi tool-result extensions to middleware” 已涵盖。为完整性也列在这里:已移除的仅 Pi api.registerEmbeddedExtensionFactory(...) 路径由 api.registerAgentToolResultMiddleware(...) 替代,并在 contracts.agentToolResultMiddleware 中提供显式运行时列表。
openclaw/plugin-sdk 重新导出的 OpenClawSchemaType 现在是 OpenClawConfig 的单行别名。请优先使用规范名称。
// Before
import type { OpenClawSchemaType } from "openclaw/plugin-sdk";
// After
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-schema";
扩展级弃用项(位于 extensions/ 下的内置渠道/提供商插件内部) 会在它们自己的 api.tsruntime-api.ts 桶中跟踪。它们不影响第三方插件契约,因此不会列在这里。 如果你直接使用某个内置插件的本地桶,请在升级前阅读该桶中的 弃用注释。

移除时间线

时间会发生什么
现在已弃用表面会发出运行时警告
下一个主版本已弃用表面将被移除;仍使用它们的插件将失败
所有核心插件都已经迁移。外部插件应在下一个主版本发布前迁移。

临时抑制警告

在迁移期间设置这些环境变量:
OPENCLAW_SUPPRESS_PLUGIN_SDK_COMPAT_WARNING=1 openclaw gateway run
OPENCLAW_SUPPRESS_EXTENSION_API_WARNING=1 openclaw gateway run
这是临时逃生口,不是永久解决方案。

相关内容