Skip to main content

Documentation Index

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

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

该插件 SDK 作为 openclaw/plugin-sdk/ 下的一组窄子路径公开。 本页按用途分组列出常用子路径。生成的 200+ 个子路径完整列表位于 scripts/lib/plugin-sdk-entrypoints.json； 保留的内置插件辅助子路径也会出现在其中，但除非文档页面明确提升它们，否则它们属于实现细节。维护者可以用 pnpm plugins:boundary-report:summary 审核活跃的保留辅助子路径；未使用的保留辅助导出会使 CI 报告失败，而不是作为休眠的兼容性债务留在公共 SDK 中。 插件编写指南见 插件 SDK 概览。

​
插件入口

子路径关键导出
plugin-sdk/plugin-entrydefinePluginEntry
plugin-sdk/coredefineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema, buildJsonChannelConfigSchema
plugin-sdk/config-schemaOpenClawSchema
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
plugin-sdk/testing旧版插件测试的宽兼容性 barrel；新的插件测试优先使用聚焦的测试子路径
plugin-sdk/plugin-test-api用于直接插件注册单元测试的最小 OpenClawPluginApi mock 构建器
plugin-sdk/agent-runtime-test-contracts原生 agent-runtime 适配器契约 fixture，涵盖身份凭证配置、递送抑制、fallback 分类、工具钩子、prompt 覆盖层、schema 和转录修复
plugin-sdk/channel-test-helpers渠道账号生命周期、目录、发送配置、运行时 mock、钩子、内置渠道入口、envelope 时间戳、配对回复和通用渠道契约测试辅助工具
plugin-sdk/channel-target-testing共享的渠道目标解析错误案例测试套件
plugin-sdk/plugin-test-contracts插件注册、包清单、公共 artifact、运行时 API、导入副作用和直接导入契约辅助工具
plugin-sdk/plugin-test-runtime用于测试的插件运行时、注册表、提供商注册、设置向导和运行时任务流 fixture
plugin-sdk/provider-test-contracts提供商运行时、身份凭证、设备发现、新手引导、目录、媒体能力、重放策略、实时 STT 现场音频、Web 搜索/抓取和向导契约辅助工具
plugin-sdk/provider-http-test-mocks面向执行 plugin-sdk/provider-http 的提供商测试的可选 Vitest HTTP/身份凭证 mock
plugin-sdk/test-env测试环境、fetch/网络、一次性 HTTP 服务器、传入请求、live-test、临时文件系统和时间控制 fixture
plugin-sdk/test-fixtures通用 CLI、沙箱、skill、智能体消息、系统事件、模块重新加载、内置插件路径、终端、分块、身份凭证 token 和类型化用例测试 fixture
plugin-sdk/test-node-mocks用于 Vitest vi.mock("node:*") 工厂内部的聚焦 Node 内置 mock 辅助工具
plugin-sdk/migration迁移提供商条目辅助工具，例如 createMigrationItem、原因常量、条目状态标记、脱敏辅助工具和 summarizeMigrationItems
plugin-sdk/migration-runtime运行时迁移辅助工具，例如 copyMigrationFileItem、withCachedMigrationConfigRuntime 和 writeMigrationReport
子路径关键导出
plugin-sdk/channel-coredefineChannelPluginEntry, defineSetupPluginEntry, createChatChannelPlugin, createChannelPluginBase
plugin-sdk/config-schema根 openclaw.json Zod schema 导出（OpenClawSchema）
plugin-sdk/channel-setupcreateOptionalChannelSetupSurface, createOptionalChannelSetupAdapter, createOptionalChannelSetupWizard，以及 DEFAULT_ACCOUNT_ID, createTopLevelChannelDmPolicy, setSetupChannelEnabled, splitSetupEntries
plugin-sdk/setup共享设置向导辅助工具、allowlist prompt、设置状态构建器
plugin-sdk/setup-runtimecreatePatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy
plugin-sdk/setup-adapter-runtimecreateEnvPatchedAccountSetupAdapter
plugin-sdk/setup-toolsformatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR
plugin-sdk/account-core多账号配置/操作门控辅助工具、默认账号 fallback 辅助工具
plugin-sdk/account-idDEFAULT_ACCOUNT_ID、账号 ID 规范化辅助工具
plugin-sdk/account-resolution账号查找 + 默认 fallback 辅助工具
plugin-sdk/account-helpers窄账号列表/账号操作辅助工具
plugin-sdk/channel-pairingcreateChannelPairingController
plugin-sdk/channel-reply-pipelinecreateChannelReplyPipeline, resolveChannelSourceReplyDeliveryMode
plugin-sdk/channel-config-helperscreateHybridChannelConfigAdapter, resolveChannelDmAccess, resolveChannelDmAllowFrom, resolveChannelDmPolicy, normalizeChannelDmPolicy, normalizeLegacyDmAliases
plugin-sdk/channel-config-schema共享渠道配置 schema 原语，以及 Zod 和直接 JSON/TypeBox 构建器
plugin-sdk/bundled-channel-config-schema仅供维护中的内置插件使用的内置 OpenClaw 渠道配置 schema
plugin-sdk/channel-config-schema-legacy内置渠道配置 schema 的已弃用兼容性别名
plugin-sdk/telegram-command-configTelegram 自定义命令规范化/验证辅助工具，带内置契约 fallback
plugin-sdk/command-gating窄命令授权门控辅助工具
plugin-sdk/channel-policyresolveChannelGroupRequireMention
plugin-sdk/channel-lifecyclecreateAccountStatusSink, createChannelRunQueue，草稿流生命周期/完成辅助工具
plugin-sdk/inbound-envelope共享入站路由 + envelope 构建器辅助工具
plugin-sdk/inbound-reply-dispatch共享入站记录和调度辅助工具
plugin-sdk/messaging-targets目标解析/匹配辅助工具
plugin-sdk/outbound-media共享出站媒体加载辅助工具
plugin-sdk/outbound-send-deps面向渠道适配器的轻量出站发送依赖查找
plugin-sdk/outbound-runtime出站递送、身份、发送委托、会话、格式化和 payload 规划辅助工具
plugin-sdk/poll-runtime窄投票规范化辅助工具
plugin-sdk/thread-bindings-runtime线程绑定生命周期和适配器辅助工具
plugin-sdk/agent-media-payload旧版智能体媒体 payload 构建器
plugin-sdk/conversation-runtime对话/线程绑定、配对和已配置绑定辅助工具
plugin-sdk/runtime-config-snapshot运行时配置快照辅助工具
plugin-sdk/runtime-group-policy运行时组策略解析辅助工具
plugin-sdk/channel-status共享渠道状态快照/摘要辅助工具
plugin-sdk/channel-config-primitives窄渠道配置 schema 原语
plugin-sdk/channel-config-writes渠道配置写入授权辅助工具
plugin-sdk/channel-plugin-common共享渠道插件 prelude 导出
plugin-sdk/allowlist-config-editallowlist 配置编辑/读取辅助工具
plugin-sdk/group-access共享组访问决策辅助工具
plugin-sdk/direct-dm共享直接私信身份凭证/guard 辅助工具
plugin-sdk/discord已弃用的 Discord 兼容性 facade，用于已发布的 @openclaw/discord@2026.3.13 和跟踪中的所有者兼容性；新插件应使用通用渠道 SDK 子路径
plugin-sdk/telegram-account已弃用的 Telegram 账号解析兼容性 facade，用于跟踪中的所有者兼容性；新插件应使用注入的运行时辅助工具或通用渠道 SDK 子路径
plugin-sdk/zalouser已弃用的 Zalo Personal 兼容性 facade，用于仍导入发送者命令授权的已发布 Lark/Zalo 包；新插件应使用 plugin-sdk/command-auth
plugin-sdk/interactive-runtime语义消息呈现、递送和旧版交互式回复辅助工具。见 消息呈现
plugin-sdk/channel-inbound入站 debounce、mention 匹配、mention-policy 辅助工具和 envelope 辅助工具的兼容性 barrel
plugin-sdk/channel-inbound-debounce窄入站 debounce 辅助工具
plugin-sdk/channel-mention-gating窄 mention-policy、mention 标记和 mention 文本辅助工具，不包含更宽的入站运行时 surface
plugin-sdk/channel-envelope窄入站 envelope 格式化辅助工具
plugin-sdk/channel-location渠道位置上下文和格式化辅助工具
plugin-sdk/channel-logging入站丢弃和 typing/ack 失败的渠道日志辅助工具
plugin-sdk/channel-send-result回复结果类型
plugin-sdk/channel-actions渠道消息操作辅助工具，以及为插件兼容性保留的已弃用原生 schema 辅助工具
plugin-sdk/channel-route共享路由规范化、解析器驱动的目标解析、thread-id 字符串化、去重/紧凑路由键、已解析目标类型，以及路由/目标比较辅助工具
plugin-sdk/channel-targets目标解析辅助工具；路由比较调用方应使用 plugin-sdk/channel-route
plugin-sdk/channel-contract渠道契约类型
plugin-sdk/channel-feedback反馈/reaction 接线
plugin-sdk/channel-secret-runtime窄 secret-contract 辅助工具，例如 collectSimpleChannelFieldAssignments、getChannelSurface、pushAssignment 和 secret 目标类型
子路径关键导出
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
plugin-sdk/lmstudio用于设置、目录设备发现和运行时模型准备的受支持 LM Studio 提供商外观
plugin-sdk/lmstudio-runtime用于本地服务器默认值、模型设备发现、请求标头和已加载模型帮助程序的受支持 LM Studio 运行时外观
plugin-sdk/provider-setup精选的本地/自托管提供商设置帮助程序
plugin-sdk/self-hosted-provider-setup专注于 OpenAI 兼容自托管提供商的设置帮助程序
plugin-sdk/cli-backendCLI 后端默认值 + 监视器常量
plugin-sdk/provider-auth-runtime面向提供商插件的运行时 API 密钥解析帮助程序
plugin-sdk/provider-auth-api-keyAPI 密钥新手引导/配置文件写入帮助程序，例如 upsertApiKeyProfile
plugin-sdk/provider-auth-result标准 OAuth 凭证结果构建器
plugin-sdk/provider-auth-login面向提供商插件的共享交互式登录帮助程序
plugin-sdk/provider-env-vars提供商凭证环境变量查找帮助程序
plugin-sdk/provider-authcreateProviderApiKeyAuthMethod, ensureApiKeyFromOptionEnvOrPrompt, upsertAuthProfile, upsertApiKeyProfile, writeOAuthCredentials
plugin-sdk/provider-model-sharedProviderReplayFamily, buildProviderReplayFamilyHooks, normalizeModelCompat、共享回放策略构建器、提供商端点帮助程序，以及模型 ID 规范化帮助程序，例如 normalizeNativeXaiModelId
plugin-sdk/provider-catalog-runtime用于契约测试的提供商目录扩充运行时钩子和插件提供商注册表衔接点
plugin-sdk/provider-catalog-sharedfindCatalogTemplate, buildSingleProviderApiKeyCatalog, buildManifestModelProviderConfig, supportsNativeStreamingUsageCompat, applyProviderNativeStreamingUsageCompat
plugin-sdk/provider-http通用提供商 HTTP/端点能力帮助程序、提供商 HTTP 错误，以及音频转录 multipart 表单帮助程序
plugin-sdk/provider-web-fetch-contract精简的 Web 抓取配置/选择契约帮助程序，例如 enablePluginInConfig 和 WebFetchProviderPlugin
plugin-sdk/provider-web-fetchWeb 抓取提供商注册/缓存帮助程序
plugin-sdk/provider-web-search-config-contract面向不需要插件启用接线的提供商的精简 Web 搜索配置/凭证帮助程序
plugin-sdk/provider-web-search-contract精简的 Web 搜索配置/凭证契约帮助程序，例如 createWebSearchProviderContractFields, enablePluginInConfig, resolveProviderWebSearchPluginConfig，以及作用域凭证设置器/获取器
plugin-sdk/provider-web-searchWeb 搜索提供商注册/缓存/运行时帮助程序
plugin-sdk/provider-toolsProviderToolCompatFamily, buildProviderToolCompatFamilyHooks、Gemini 架构清理 + 诊断，以及 xAI 兼容性帮助程序，例如 resolveXaiModelCompatPatch / applyXaiModelCompat
plugin-sdk/provider-usagefetchClaudeUsage 及类似内容
plugin-sdk/provider-streamProviderStreamFamily, buildProviderStreamFamilyHooks, composeProviderStreamWrappers、流包装器类型，以及共享的 Anthropic/Bedrock/DeepSeek V4/Google/Kilocode/Moonshot/OpenAI/OpenRouter/Z.A.I/MiniMax/Copilot 包装器帮助程序
plugin-sdk/provider-transport-runtime原生提供商传输帮助程序，例如受保护的 fetch、传输消息转换和可写传输事件流
plugin-sdk/provider-onboard新手引导配置补丁帮助程序
plugin-sdk/global-singleton进程本地单例/map/缓存帮助程序
plugin-sdk/group-activation精简的群组激活模式和命令解析帮助程序
子路径关键导出
plugin-sdk/command-authresolveControlCommandGate、命令注册表帮助程序，包括动态参数菜单格式化、发送者授权帮助程序
plugin-sdk/command-status命令/帮助消息构建器，例如 buildCommandsMessagePaginated 和 buildHelpMessage
plugin-sdk/approval-auth-runtime审批人解析和同聊天操作凭证帮助程序
plugin-sdk/approval-client-runtime原生 exec 审批配置文件/过滤器帮助程序
plugin-sdk/approval-delivery-runtime原生审批能力/交付适配器
plugin-sdk/approval-gateway-runtime共享审批 Gateway 网关解析帮助程序
plugin-sdk/approval-handler-adapter-runtime面向热渠道入口点的轻量级原生审批适配器加载帮助程序
plugin-sdk/approval-handler-runtime更广泛的审批处理程序运行时帮助程序；当更窄的适配器/Gateway 网关衔接点足够时优先使用它们
plugin-sdk/approval-native-runtime原生审批目标 + 账号绑定帮助程序
plugin-sdk/approval-reply-runtimeexec/插件审批回复载荷帮助程序
plugin-sdk/approval-runtimeexec/插件审批载荷帮助程序、原生审批路由/运行时帮助程序，以及结构化审批显示帮助程序，例如 formatApprovalDisplayPath
plugin-sdk/reply-dedupe精简的入站回复去重重置帮助程序
plugin-sdk/channel-contract-testing不依赖宽泛测试 barrel 的精简渠道契约测试帮助程序
plugin-sdk/command-auth-native原生命令凭证、动态参数菜单格式化，以及原生会话目标帮助程序
plugin-sdk/command-detection共享命令检测帮助程序
plugin-sdk/command-primitives-runtime面向热渠道路径的轻量级命令文本谓词
plugin-sdk/command-surface命令正文规范化和命令表面帮助程序
plugin-sdk/allow-fromformatAllowFromLowercase
plugin-sdk/channel-secret-runtime面向渠道/插件密钥表面的精简密钥契约收集帮助程序
plugin-sdk/secret-ref-runtime面向密钥契约/配置解析的精简 coerceSecretRef 和 SecretRef 类型帮助程序
plugin-sdk/security-runtime共享信任、私信 门控、外部内容、敏感文本脱敏、常量时间密钥比较和密钥收集帮助程序
plugin-sdk/ssrf-policy主机允许列表和私有网络 SSRF 策略帮助程序
plugin-sdk/ssrf-dispatcher不包含宽泛基础设施运行时表面的精简固定 dispatcher 帮助程序
plugin-sdk/ssrf-runtime固定 dispatcher、SSRF 保护的 fetch、SSRF 错误和 SSRF 策略帮助程序
plugin-sdk/secret-input密钥输入解析帮助程序
plugin-sdk/webhook-ingressWebhook 请求/目标帮助程序，以及原始 websocket/body 强制转换
plugin-sdk/webhook-request-guards请求正文大小/超时帮助程序
子路径主要导出
plugin-sdk/media-runtime共享媒体获取/转换/存储辅助函数、基于 ffprobe 的视频尺寸探测，以及媒体负载构建器
plugin-sdk/media-store窄范围媒体存储辅助函数，例如 saveMediaBuffer
plugin-sdk/media-generation-runtime共享媒体生成故障转移辅助函数、候选选择，以及缺失模型提示消息
plugin-sdk/media-understanding媒体理解提供商类型，以及面向提供商的图像/音频辅助导出
plugin-sdk/text-runtime共享文本/Markdown/日志辅助函数，例如剥离智能体可见文本、Markdown 渲染/分块/表格辅助函数、脱敏辅助函数、指令标签辅助函数，以及安全文本工具
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/webhook-targetsWebhook 目标注册表和路由安装辅助函数
plugin-sdk/webhook-pathWebhook 路径规范化辅助函数
plugin-sdk/web-media共享远程/本地媒体加载辅助函数
plugin-sdk/zod为插件 SDK 使用者重新导出的 zod
plugin-sdk/testing用于旧版插件测试的宽兼容性 barrel。新的扩展测试应改为导入聚焦的 SDK 子路径，例如 plugin-sdk/agent-runtime-test-contracts、plugin-sdk/plugin-test-runtime、plugin-sdk/channel-test-helpers、plugin-sdk/test-env 或 plugin-sdk/test-fixtures
plugin-sdk/plugin-test-api最小的 createTestPluginApi 辅助函数，用于直接插件注册单元测试，无需导入仓库测试辅助桥接
plugin-sdk/agent-runtime-test-contracts用于鉴权、投递、回退、工具钩子、提示词叠加、schema 和转录投影测试的原生智能体运行时适配器契约 fixture
plugin-sdk/channel-test-helpers面向渠道的测试辅助函数，用于通用操作/设置/Status 契约、目录断言、账号启动生命周期、发送配置线程、运行时 mock、状态问题、出站投递和钩子注册
plugin-sdk/channel-target-testing用于渠道测试的共享目标解析错误用例套件
plugin-sdk/plugin-test-contracts插件包、注册、公共工件、直接导入、运行时 API 和导入副作用契约辅助函数
plugin-sdk/provider-test-contracts提供商运行时、鉴权、设备发现、新手引导、目录、向导、媒体能力、重放策略、实时 STT 现场音频、Web 搜索/获取和流式传输契约辅助函数
plugin-sdk/provider-http-test-mocks可选启用的 Vitest HTTP/鉴权 mock，用于测试 plugin-sdk/provider-http 的提供商测试
plugin-sdk/test-fixtures通用 CLI 运行时捕获、沙箱上下文、Skill 写入器、智能体消息、系统事件、模块重载、内置插件路径、终端文本、分块、鉴权令牌和类型化用例 fixture
plugin-sdk/test-node-mocks聚焦的 Node 内置 mock 辅助函数，用于 Vitest vi.mock("node:*") 工厂内部
子路径主要导出
plugin-sdk/memory-core用于管理器/配置/文件/CLI 辅助函数的内置 memory-core 辅助接口
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 引擎导出
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-core-host-status记忆主机 Status 辅助函数
plugin-sdk/memory-core-host-runtime-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-host-markdown供记忆相邻插件使用的共享托管 Markdown 辅助函数
plugin-sdk/memory-host-search用于搜索管理器访问的主动记忆运行时门面
plugin-sdk/memory-host-status记忆主机 Status 辅助函数的供应商中立别名
当前没有预留的内置辅助 SDK 子路径。所有者特定的 辅助函数位于拥有它的插件包内，而可复用的主机契约 使用通用 SDK 子路径，例如 plugin-sdk/gateway-runtime、 plugin-sdk/security-runtime 和 plugin-sdk/plugin-config-runtime。

​
相关内容