Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

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

每个插件都会导出一个默认入口对象。SDK 提供了三个辅助函数用于创建它们。 对于已安装的插件，package.json 在可用时应将运行时加载指向构建后的 JavaScript： 
{
  "openclaw": {
    "extensions": ["./src/index.ts"],
    "runtimeExtensions": ["./dist/index.js"],
    "setupEntry": "./src/setup-entry.ts",
    "runtimeSetupEntry": "./dist/setup-entry.js"
  }
}
extensions 和 setupEntry 对于工作区和 git 检出开发仍然有效。runtimeExtensions 和 runtimeSetupEntry 在 OpenClaw 加载已安装包时更受青睐，并允许 npm 包避免运行时 TypeScript 编译。显式运行时入口是必需的：runtimeSetupEntry 需要 setupEntry，而缺少 runtimeExtensions 或 runtimeSetupEntry 制品会导致安装/发现失败，而不是静默回退到源代码。如果 已安装包只声明了一个 TypeScript 源入口，OpenClaw 会在存在时使用 匹配的构建后 dist/*.js 同级文件，然后再回退到 TypeScript 源文件。 所有入口路径都必须保持在插件包目录内。运行时入口以及推断出的构建后 JavaScript 同级文件，不能让一个会越界的 extensions 或 setupEntry 源路径变得有效。
在寻找操作指南吗？ 请参见 Channel Plugins 或 Provider Plugins 获取逐步指南。

​
definePluginEntry

导入： openclaw/plugin-sdk/plugin-entry 适用于 provider 插件、tool 插件、hook 插件，以及任何不是消息通道的内容。 
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";

export default definePluginEntry({
  id: "my-plugin",
  name: "我的插件",
  description: "简短摘要",
  register(api) {
    api.registerProvider({
      /* ... */
    });
    api.registerTool({
      /* ... */
    });
  },
});
字段类型必需默认值
idstring是—
namestring是—
descriptionstring是—
kindstring否—
configSchemaOpenClawPluginConfigSchema | () => OpenClawPluginConfigSchema否空对象 schema
register(api: OpenClawPluginApi) => void是—
  • id 必须与 openclaw.plugin.json 清单匹配。
  • kind 用于独占槽位："memory" 或 "context-engine"。
  • configSchema 可以是一个用于延迟求值的函数。
  • OpenClaw 会在首次访问时解析并记忆化该 schema，因此开销较大的 schema 构建器只会运行一次。

​
defineChannelPluginEntry

导入： openclaw/plugin-sdk/channel-core 对 definePluginEntry 进行通道特定封装。它会自动调用 api.registerChannel({ plugin })，暴露一个可选的根帮助 CLI 元数据接口，并根据注册模式对 registerFull 进行门控。 
import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineChannelPluginEntry({
  id: "my-channel",
  name: "我的通道",
  description: "简短摘要",
  plugin: myChannelPlugin,
  setRuntime: setMyRuntime,
  registerCliMetadata(api) {
    api.registerCli(/* ... */);
  },
  registerFull(api) {
    api.registerGatewayMethod(/* ... */);
  },
});
字段类型必需默认值
idstring是—
namestring是—
descriptionstring是—
pluginChannelPlugin是—
configSchemaOpenClawPluginConfigSchema | () => OpenClawPluginConfigSchema否空对象 schema
setRuntime(runtime: PluginRuntime) => void否—
registerCliMetadata(api: OpenClawPluginApi) => void否—
registerFull(api: OpenClawPluginApi) => void否—
  • setRuntime 会在注册期间调用，因此你可以存储运行时引用（通常通过 createPluginRuntimeStore）。在 CLI 元数据捕获期间会跳过它。
  • registerCliMetadata 会在 api.registrationMode === "cli-metadata"、api.registrationMode === "discovery" 和 api.registrationMode === "full" 时运行。 将其作为通道自有 CLI 描述符的规范位置，这样根帮助就保持非激活，发现快照会包含静态命令元数据，并且常规 CLI 命令注册仍然与完整插件加载兼容。
  • 发现注册是非激活的，但不是免导入的。OpenClaw 可能会计算受信任的插件入口和通道插件模块来构建快照，因此请保持顶层导入无副作用，并将 sockets、clients、workers 和 services 放在仅 "full" 的路径之后。
  • registerFull 仅在 api.registrationMode === "full" 时运行。在仅 setup 加载期间会跳过它。
  • 与 definePluginEntry 类似，configSchema 可以是一个懒工厂，OpenClaw 会在首次访问时缓存解析后的 schema。
  • 对于插件拥有的根 CLI 命令，如果你希望命令保持懒加载但又不从根 CLI 解析树中消失，优先使用 api.registerCli(..., { descriptors: [...] })。对于通道插件，优先在 registerCliMetadata(...) 中注册这些描述符，并让 registerFull(...) 专注于仅运行时工作。
  • 如果 registerFull(...) 还注册了 gateway RPC 方法，请将它们放在插件专属前缀下。保留的核心管理员命名空间（config.*、exec.approvals.*、wizard.*、update.*）始终会被强制为 operator.admin。

​
defineSetupPluginEntry

导入： openclaw/plugin-sdk/channel-core 用于轻量级的 setup-entry.ts 文件。只返回 { plugin }，不包含运行时或 CLI 接线。 
import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineSetupPluginEntry(myChannelPlugin);
当通道被禁用、未配置，或者启用了延迟加载时，OpenClaw 会加载这个入口而不是完整入口。有关这在何时重要，请参见 Setup and Config。 实践中，将 defineSetupPluginEntry(...) 与以下窄范围 setup 辅助族配对使用：
  • openclaw/plugin-sdk/setup-runtime，用于运行时安全的 setup 辅助，例如 import-safe setup patch 适配器、lookup-note 输出、 promptResolvedAllowFrom、splitSetupEntries 和委托式 setup 代理
  • openclaw/plugin-sdk/channel-setup，用于可选安装的 setup 表面
  • openclaw/plugin-sdk/setup-tools，用于 setup/install CLI/archive/docs 辅助
将重型 SDK、CLI 注册以及长生命周期的运行时服务保留在完整入口中。 分离 setup 和 runtime 表面的打包工作区通道可以改用 openclaw/plugin-sdk/channel-entry-contract 中的 defineBundledChannelSetupEntry(...)。 该契约允许 setup 入口保留 setup 安全的 plugin/secrets 导出，同时仍然暴露一个运行时 setter： 
import { defineBundledChannelSetupEntry } from "openclaw/plugin-sdk/channel-entry-contract";

export default defineBundledChannelSetupEntry({
  importMetaUrl: import.meta.url,
  plugin: {
    specifier: "./channel-plugin-api.js",
    exportName: "myChannelPlugin",
  },
  runtime: {
    specifier: "./runtime-api.js",
    exportName: "setMyChannelRuntime",
  },
});
只有在 setup 流程确实需要在完整通道入口加载之前提供一个轻量级运行时 setter 时，才使用这个打包契约。

​
注册模式

api.registrationMode 会告诉你的插件它是如何被加载的：
模式何时需要注册的内容
"full"正常 gateway 启动全部内容
"discovery"只读能力发现通道注册加静态 CLI 描述符；入口代码可能会加载，但要跳过 sockets、workers、clients 和 services
"setup-only"被禁用/未配置的通道仅通道注册
"setup-runtime"带有可用运行时的 setup 流程通道注册加上在完整入口加载之前所需的轻量级运行时
"cli-metadata"根帮助 / CLI 元数据捕获仅 CLI 描述符
defineChannelPluginEntry 会自动处理这种拆分。如果你直接为通道使用 definePluginEntry，则需要自己检查模式： 
register(api) {
  if (
    api.registrationMode === "cli-metadata" ||
    api.registrationMode === "discovery" ||
    api.registrationMode === "full"
  ) {
    api.registerCli(/* ... */);
    if (api.registrationMode === "cli-metadata") return;
  }

  api.registerChannel({ plugin: myPlugin });
  if (api.registrationMode !== "full") return;

  // 仅运行时的重型注册
  api.registerService(/* ... */);
}
发现模式会构建一个非激活的注册表快照。它仍可能计算插件入口和通道插件对象，以便 OpenClaw 可以注册通道能力和静态 CLI 描述符。将发现过程中的模块求值视为受信任但轻量：不要在顶层引入网络客户端、子进程、监听器、数据库连接、后台 worker、凭据读取或其他实时运行时副作用。 将 "setup-runtime" 视为 setup-only 启动表面必须存在、但不能重新进入完整打包通道运行时的窗口。适合的内容包括通道注册、setup 安全的 HTTP 路由、setup 安全的 gateway 方法，以及委托式 setup 辅助。重型后台服务、CLI 注册器和 provider/client SDK 启动仍然属于 "full"。 针对 CLI 注册器而言：
  • 当注册器拥有一个或多个根命令，并且你希望 OpenClaw 在首次调用时懒加载真实的 CLI 模块时，请使用 descriptors
  • 确保这些描述符覆盖注册器暴露的每一个顶层命令根
  • 将描述符命令名限制为字母、数字、连字符和下划线，并且以字母或数字开头；OpenClaw 会拒绝不符合该形状的描述符名称，并在渲染帮助之前剥离描述中的终端控制序列
  • 仅在急切兼容路径中单独使用 commands

​
插件形态

OpenClaw 根据已加载插件的注册行为对其进行分类：
形态描述
plain-capability一种能力类型（例如，仅 provider）
hybrid-capability多种能力类型（例如，provider + speech）
hook-only仅有 hooks，没有 capabilities
non-capability工具/命令/服务，但没有 capabilities
使用 openclaw plugins inspect <id> 查看插件的形态。

​
相关