插件入口点

​

包入口

{
  "openclaw": {
    "extensions": ["./src/index.ts"],
    "runtimeExtensions": ["./dist/index.js"],
    "setupEntry": "./src/setup-entry.ts",
    "runtimeSetupEntry": "./dist/setup-entry.js"
  }
}

• extensions 和 setupEntry 是源码入口，用于工作区和 git 检出开发。
• 对于已安装的包，优先使用 runtimeExtensions 和 runtimeSetupEntry： 它们使 npm 包可以跳过运行时 TypeScript 编译。
• runtimeExtensions（如果存在）的数组长度必须与 extensions 一致 （入口按位置配对）。runtimeSetupEntry 需要 setupEntry。
• 如果声明了 runtimeExtensions/runtimeSetupEntry 工件但该工件 缺失，安装/发现会因打包错误而失败；OpenClaw 不会 静默回退到源码。仅当完全未声明运行时入口时，才会应用源码回退 （见下文）。
• 如果已安装的包仅声明 TypeScript 源码入口，OpenClaw 会查找匹配的构建后 dist/*.js（或 .mjs/.cjs）对应文件并使用它； 否则会回退到 TypeScript 源码。
• 所有入口路径都必须位于插件包目录内。运行时 入口和推断出的构建后 JS 对应文件并不能让越界的 extensions 或 setupEntry 源码路径变为有效路径。

​

defineToolPlugin

import { Type } from "typebox";
import { defineToolPlugin } from "openclaw/plugin-sdk/tool-plugin";

export default defineToolPlugin({
  id: "stock-quotes",
  name: "Stock Quotes",
  description: "Fetch stock quotes.",
  configSchema: Type.Object({
    apiKey: Type.Optional(Type.String({ description: "API key." })),
  }),
  tools: (tool) => [
    tool({
      name: "quote",
      label: "Quote",
      description: "Fetch a quote.",
      parameters: Type.Object({
        symbol: Type.String({ description: "Ticker symbol." }),
      }),
      outputSchema: Type.Object(
        {
          symbol: Type.String(),
          hasKey: Type.Boolean(),
        },
        { additionalProperties: false },
      ),
      execute: async ({ symbol }, config) => ({ symbol, hasKey: Boolean(config.apiKey) }),
    }),
  ],
});

• configSchema 是可选的；省略时将使用严格的空对象 schema （生成的清单仍包含 configSchema）。
• execute 返回普通字符串或可序列化为 JSON 的值；该辅助函数 会将其包装为文本工具结果，并将 details 设为原始的 （未字符串化）返回值。
• outputSchema 可选择描述该原始 details 值，以供代码模式 和工具搜索使用。目录调用会在执行前拒绝无效的 schema， 并在返回最终值前对其进行验证。
• 对于自定义工具结果，openclaw/plugin-sdk/tool-results 会导出 textResult 和 jsonResult。
• 工具名称是静态的，因此 openclaw plugins build 会根据声明的工具推导出 contracts.tools，无需手动重复名称。
• 运行时加载仍保持严格：已安装的插件仍需要 openclaw.plugin.json 和 package.json openclaw.extensions。OpenClaw 绝不会执行插件代码来推断缺失的清单数据。

​

definePluginEntry

import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";

export default definePluginEntry({
  id: "my-plugin",
  name: "My Plugin",
  description: "Short summary",
  register(api) {
    api.registerProvider({/* ... */});
    api.registerTool({/* ... */});
  },
});

• id 必须与你的 openclaw.plugin.json 清单匹配。
• 外部会话目录使用 openclaw/plugin-sdk/session-catalog 和 api.registerSessionCatalog({ id, label, list, read, continueSession?, archive? })。 核心负责 sessions.catalog.* Gateway 网关方法；提供商返回主机、 会话和规范化的转录投影，而不注册 RPC。列表提供商应在每个主机 完成处理时调用可选的 onHost(host) 回调；返回的主机数组仍须作为最终的兼容性 快照。
• kind 已弃用：请改为在 openclaw.plugin.json 清单的 kind 字段中 声明独占槽位（"memory" 或 "context-engine"）。运行时入口 kind 仅作为旧插件的兼容性回退而保留。
• configSchema 可以是用于惰性求值的函数。OpenClaw 会在首次访问时解析并 记忆该 schema，因此开销较大的 schema 构建器只会运行 一次。
• nodeHostCommands 描述符可以定义 isAvailable({ config, env })。 返回 false 会从无头节点的 Gateway 网关声明中省略该命令及其能力。 OpenClaw 会根据节点本地的启动配置对其求值；命令处理程序在 调用时仍应验证可用性。

​

defineChannelPluginEntry

import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineChannelPluginEntry({
  id: "my-channel",
  name: "My Channel",
  description: "Short summary",
  plugin: myChannelPlugin,
  setRuntime: setMyRuntime,
  registerCliMetadata(api) {
    api.registerCli(/* ... */);
  },
  registerFull(api) {
    api.registerGatewayMethod(/* ... */);
  },
});

• setRuntime 会在除 "cli-metadata" 和 "tool-discovery" 之外的所有模式下运行。通常通过 createPluginRuntimeStore 在此处存储运行时引用。
• registerCliMetadata 会为 "cli-metadata"、"discovery" 和 "full" 运行。将其作为渠道自有 CLI 描述符的规范位置， 以便根帮助保持非激活状态、发现快照包含静态 命令元数据，并使常规 CLI 注册与完整 插件加载保持兼容。
• registerFull 仅为 "full" 和 "tool-discovery" 运行。对于 "tool-discovery"，它会_取代_渠道注册而运行：OpenClaw 会完全跳过 registerChannel/setRuntime，并且只调用 registerFull，因此渠道独立进行工具发现或执行所需的任何提供商/工具注册 都必须放在此处，而不能放在常规渠道设置之后。
• 发现注册是非激活式的，但并非不进行导入：OpenClaw 可能会 求值受信任的插件入口和渠道插件模块以构建 快照。保持顶层导入无副作用，并将套接字、 客户端、工作进程和服务放在仅限 "full" 的路径之后。
• 与 definePluginEntry 类似，configSchema 可以是惰性工厂；OpenClaw 会在首次访问时记忆解析后的 schema。

• 对于希望延迟加载、但又不想从根 CLI 解析树中消失的插件自有根 CLI 命令，请使用 api.registerCli(..., { descriptors: [...] })。 描述符名称必须仅包含字母、数字、连字符和下划线，并以字母或数字开头； OpenClaw 会拒绝其他格式，并在呈现帮助信息前从描述中移除终端控制序列。 请覆盖注册器公开的每个顶级命令根。仅使用 commands 时仍会走预加载兼容路径。
• 对于已配对节点的功能命令，请使用 api.registerNodeCliFeature(...)， 使其归入 openclaw nodes（等同于 registerCli(registrar, { parentPath: ["nodes"], ... })）。
• 对于其他嵌套插件命令，请添加 parentPath，并在传给注册器的 program 对象上注册命令；OpenClaw 会先将其解析为父命令， 再调用插件。
• 对于渠道插件，请从 registerCliMetadata 注册 CLI 描述符， 并让 registerFull 专注于仅运行时工作。
• 如果 registerFull 还注册了 Gateway 网关 RPC 方法，请将其置于 插件专用前缀下。保留的核心管理命名空间（config.*、 exec.approvals.*、wizard.*、update.*）始终会被强制转换为 operator.admin。

​

defineSetupPluginEntry

import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineSetupPluginEntry(myChannelPlugin);

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",
  },
  registerSetupRuntime(api) {
    api.registerHttpRoute({
      path: "/my-channel/events",
      auth: "plugin",
      handler: async (req, res) => {
        /* 设置安全的路由 */
      },
    });
  },
});

​

注册模式

register(api) {
  if (
    api.registrationMode === "cli-metadata" ||
    api.registrationMode === "discovery" ||
    api.registrationMode === "full"
  ) {
    api.registerCli(/* ... */);
    if (api.registrationMode === "cli-metadata") return;
  }

  if (api.registrationMode === "tool-discovery") {
    // 仅注册能力界面（提供商/工具），不注册渠道。
    return;
  }

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

  // 仅运行时的大型注册项
  api.registerService(/* ... */);
}

api.registerService({
  id: "index-events",
  start(ctx) {
    ctx.gatewayEvents?.emit("changed", { revision: 1 }, { scope: "operator.read" });
  },
});

​

插件形态

​

相关内容

• SDK 概览 - 注册 API 和子路径参考
• 运行时辅助工具 - api.runtime 和 createPluginRuntimeStore
• 设置和配置 - 插件清单、设置入口、延迟加载
• 渠道插件 - 构建 ChannelPlugin 对象
• 提供商插件 - 提供商注册和钩子