概述

Plugin SDK 以一组窄子路径形式暴露在 openclaw/plugin-sdk/ 下。每个子路径是独立的小模块,按用途分组。可用 pnpm plugin-sdk:surface 审计公开导出数量。

核心 API

插件入口子路径

子路径关键导出
plugin-sdk/plugin-entrydefinePluginEntry
plugin-sdk/channel-coredefineChannelPluginEntry, createChatChannelPlugin, defineSetupPluginEntry, buildChannelConfigSchema
plugin-sdk/provider-entrydefineSingleProviderPluginEntry
plugin-sdk/migration迁移辅助工具

Channel 子路径(常用)

子路径用途
plugin-sdk/channel-setup可选安装 setup 界面构建器
plugin-sdk/setup-runtimesetup 时运行时辅助工具(import 安全)
plugin-sdk/setup-toolssetup/安装 CLI/归档/文档辅助工具
plugin-sdk/account-core多账号配置/操作门控辅助工具
plugin-sdk/channel-ingress-runtime实验性高级 channel 入站运行时解析器
plugin-sdk/channel-message消息生命周期契约辅助工具
plugin-sdk/channel-message-runtime运行时投递辅助工具
plugin-sdk/channel-mention-gating提及策略决策辅助工具

Provider 子路径(常用)

子路径用途
plugin-sdk/provider-authAPI Key 认证方法
plugin-sdk/provider-model-shared共享 replay/模型辅助工具
plugin-sdk/provider-stream流式包装器辅助工具
plugin-sdk/provider-tools工具 Schema 兼容辅助工具
plugin-sdk/provider-http通用 HTTP/端点辅助工具
plugin-sdk/provider-catalog-sharedProvider 目录辅助工具

运行时与存储子路径(常用)

子路径用途
plugin-sdk/runtime-storecreatePluginRuntimeStore
plugin-sdk/config-contracts配置类型(OpenClawConfig 等)
plugin-sdk/config-mutation事务性配置写入
plugin-sdk/runtime-config-snapshot当前进程配置快照
plugin-sdk/security-runtime信任、DM 门控、文件路径辅助工具
plugin-sdk/gateway-runtimeGateway 客户端和 RPC 辅助工具
plugin-sdk/agent-harness实验性低级 Agent 执行器 SDK 面

能力子路径(常用)

子路径用途
plugin-sdk/speech语音 Provider 类型和辅助工具
plugin-sdk/realtime-transcription实时转录 Provider 类型
plugin-sdk/realtime-voice实时语音 Provider 类型
plugin-sdk/image-generation图像生成 Provider 类型
plugin-sdk/video-generation视频生成 Provider 类型
plugin-sdk/media-runtime共享媒体辅助工具

记忆子路径(常用)

子路径用途
plugin-sdk/memory-core捆绑记忆核心辅助工具
plugin-sdk/memory-host-core记忆宿主核心运行时辅助工具(厂商中立别名)
plugin-sdk/memory-host-search主动记忆运行时搜索管理器访问

已废弃子路径

不应在新代码中使用:plugin-sdk/compat、plugin-sdk/infra-runtime、plugin-sdk/config-runtime、plugin-sdk/channel-runtime、plugin-sdk/zod(直接从 zod 导入)。

相关页面

  • concepts/plugin-sdk-overview — 注册 API 参考
  • concepts/plugin-sdk-migration — 从废弃面迁移
  • concepts/plugin-building — 插件构建指南