插件

插件（扩展）

快速入门（插件新手？）

插件只是一个小型代码模块，它通过额外功能（命令、工具和 Gateway(网关) 网关 RPC）来扩展 OpenClaw。

大多数情况下，当你想要一个尚未内置在核心 OpenClaw 中的功能（或者你想将可选功能保留在主安装之外）时，你会使用插件。

快速路径：

1. 查看已加载的内容：

openclaw plugins list

2. 安装官方插件（示例：语音通话）：

openclaw plugins install @openclaw/voice-call

3. 重启 Gateway(网关) 网关，然后在 plugins.entries.<id>.config 下进行配置。

有关具体的插件示例，请参阅 语音通话。

可用插件（官方）

• 截至 2026.1.15，Microsoft Teams 仅支持插件模式；如果您使用 Teams，请安装 @openclaw/msteams。
• Memory (Core) — 捆绑的内存搜索插件（默认通过 plugins.slots.memory 启用）
• Memory (LanceDB) — 捆绑的长期记忆插件（自动回想/捕获；设置 plugins.slots.memory = "memory-lancedb"）
• 语音通话 — @openclaw/voice-call
• Zalo 个人版 — @openclaw/zalouser
• Matrix — @openclaw/matrix
• Nostr — @openclaw/nostr
• Zalo — @openclaw/zalo
• Microsoft Teams — @openclaw/msteams
• Google Antigravity OAuth（提供商身份验证） — 捆绑为 google-antigravity-auth（默认禁用）
• Gemini CLI OAuth（提供商身份验证） — 捆绑为 google-gemini-cli-auth（默认禁用）
• Qwen OAuth（提供商身份验证） — 捆绑为 qwen-portal-auth（默认禁用）
• Copilot Proxy（提供商身份验证） — 本地 VS Code Copilot Proxy 网桥；区别于内置的 github-copilot 设备登录（已捆绑，默认禁用）

OpenClaw 插件是通过 jiti 在运行时加载的 TypeScript 模块。配置验证不会执行插件代码，而是使用插件清单和 JSON Schema。请参阅 插件清单。

插件可以注册：

• Gateway(网关) 网关 RPC 方法
• Gateway(网关) 网关 HTTP 处理程序
• Agent 工具
• CLI 命令
• 后台服务
• 可选配置验证
• 技能（通过在插件清单中列出 skills 目录）
• 自动回复命令（执行时无需调用 AI 代理）

插件与 Gateway(网关) 网关 同进程 运行，因此请将其视为受信任的代码。 工具编写指南：插件代理工具。

运行时辅助工具

插件可以通过 api.runtime 访问选定的核心助手。对于电话 TTS：

const result = await api.runtime.tts.textToSpeechTelephony({
  text: "Hello from OpenClaw",
  cfg: api.config,
});

注意：

• 使用核心 messages.tts 配置（OpenAI 或 ElevenLabs）。
• 返回 PCM 音频缓冲区 + 采样率。插件必须为提供商重新采样/编码。
• Edge TTS 不支持电话功能。

发现与优先级

OpenClaw 按顺序扫描：

1. 配置路径

• plugins.load.paths（文件或目录）

2. 工作区扩展

• <workspace>/.openclaw/extensions/*.ts
• <workspace>/.openclaw/extensions/*/index.ts

3. 全局扩展

• ~/.openclaw/extensions/*.ts
• ~/.openclaw/extensions/*/index.ts

4. 捆绑扩展（随 OpenClaw 附带，默认禁用）

• <openclaw>/extensions/*

必须通过 plugins.entries.<id>.enabled 或 openclaw plugins enable <id> 显式启用捆绑插件。已安装的插件默认处于启用状态，但也可以通过同样的方式禁用。

每个插件必须在其根目录中包含一个 openclaw.plugin.json 文件。如果路径指向某个文件，则插件根目录为该文件所在的目录，且该目录必须包含清单文件。

如果多个插件解析为相同的 ID，则上述顺序中的第一个匹配项胜出，优先级较低的副本将被忽略。

程序包集合

插件目录可以包含带有 openclaw.extensions 的 package.json：

{
  "name": "my-pack",
  "openclaw": {
    "extensions": ["./src/safety.ts", "./src/tools.ts"]
  }
}

每个条目都会成为一个插件。如果包列出了多个扩展，插件 ID 将变为 name/<fileBase>。

如果您的插件导入了 npm 依赖项，请将其安装在该目录中，以便 node_modules 可用（npm install / pnpm install）。

通道目录元数据

通道插件可以通过 openclaw.channel 发布入门元数据，并通过 openclaw.install 发布安装提示。这使核心目录保持无数据状态。

示例：

{
  "name": "@openclaw/nextcloud-talk",
  "openclaw": {
    "extensions": ["./index.ts"],
    "channel": {
      "id": "nextcloud-talk",
      "label": "Nextcloud Talk",
      "selectionLabel": "Nextcloud Talk (self-hosted)",
      "docsPath": "/channels/nextcloud-talk",
      "docsLabel": "nextcloud-talk",
      "blurb": "Self-hosted chat via Nextcloud Talk webhook bots.",
      "order": 65,
      "aliases": ["nc-talk", "nc"]
    },
    "install": {
      "npmSpec": "@openclaw/nextcloud-talk",
      "localPath": "extensions/nextcloud-talk",
      "defaultChoice": "npm"
    }
  }
}

OpenClaw 也可以合并外部通道目录（例如，MPM 注册表导出）。将 JSON 文件放置在以下任一位置：

• ~/.openclaw/mpm/plugins.json
• ~/.openclaw/mpm/catalog.json
• ~/.openclaw/plugins/catalog.json

或者将 OPENCLAW_PLUGIN_CATALOG_PATHS（或 OPENCLAW_MPM_CATALOG_PATHS）指向一个或多个 JSON 文件（以逗号/分号/PATH 分隔）。每个文件应包含 { "entries": [ { "name": "@scope/pkg", "openclaw": { "channel": {...}, "install": {...} } } ] }。

插件 ID

默认插件 ID：

• 包：package.json name
• 独立文件：文件基本名称（~/.../voice-call.ts → voice-call）

如果插件导出了 id，OpenClaw 会使用它，但在其与配置的 ID 不匹配时会发出警告。

配置

{
  plugins: {
    enabled: true,
    allow: ["voice-call"],
    deny: ["untrusted-plugin"],
    load: { paths: ["~/Projects/oss/voice-call-extension"] },
    entries: {
      "voice-call": { enabled: true, config: { provider: "twilio" } },
    },
  },
}

字段：

• enabled：主开关（默认：true）
• allow：允许列表（可选）
• deny：拒绝列表（可选；拒绝优先）
• load.paths：额外的插件文件/目录
• entries.<id>：每个插件的开关 + 配置

配置更改需要重启网关。

验证规则（严格）：

• entries、allow、deny 或 slots 中的未知插件 ID 是错误。
• 未知的 channels.<id> 键是 错误，除非插件清单声明了 渠道 ID。
• 插件配置使用嵌入在 openclaw.plugin.json (configSchema) 中的 JSON Schema 进行验证。
• 如果插件被禁用，其配置会被保留并发出 警告。

插件槽（互斥类别）

某些插件类别是 互斥的（一次只能有一个活动）。使用 plugins.slots 来选择哪个插件拥有该槽：

{
  plugins: {
    slots: {
      memory: "memory-core", // or "none" to disable memory plugins
    },
  },
}

如果多个插件声明 kind: "memory"，则仅加载选中的那个。其他 插件将被禁用并输出诊断信息。

控制 UI（schema + 标签）

控制 UI 使用 config.schema (JSON Schema + uiHints) 来渲染更好的表单。

OpenClaw 在运行时根据发现的插件增强 uiHints：

• 为 plugins.entries.<id> / .enabled / .config 添加每个插件的标签
• 合并插件提供的可选配置字段提示，位于： plugins.entries.<id>.config.<field>

如果您希望您的插件配置字段显示良好的标签/占位符（并将机密标记为敏感）， 请在插件清单中与您的 JSON Schema 一起提供 uiHints。

示例：

{
  "id": "my-plugin",
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "apiKey": { "type": "string" },
      "region": { "type": "string" }
    }
  },
  "uiHints": {
    "apiKey": { "label": "API Key", "sensitive": true },
    "region": { "label": "Region", "placeholder": "us-east-1" }
  }
}

CLI

openclaw plugins list
openclaw plugins info <id>
openclaw plugins install <path>                 # copy a local file/dir into ~/.openclaw/extensions/<id>
openclaw plugins install ./extensions/voice-call # relative path ok
openclaw plugins install ./plugin.tgz           # install from a local tarball
openclaw plugins install ./plugin.zip           # install from a local zip
openclaw plugins install -l ./extensions/voice-call # link (no copy) for dev
openclaw plugins install @openclaw/voice-call # install from npm
openclaw plugins update <id>
openclaw plugins update --all
openclaw plugins enable <id>
openclaw plugins disable <id>
openclaw plugins doctor

plugins update 仅适用于在 plugins.installs 下跟踪的 npm 安装。

插件还可以注册自己的顶级命令（例如：openclaw voicecall）。

插件 API（概览）

插件导出以下之一：

• 一个函数：(api) => { ... }
• 一个对象：{ id, name, configSchema, register(api) { ... } }

插件钩子

插件可以附带钩子并在运行时注册它们。这使得插件可以捆绑 事件驱动的自动化，而无需单独安装钩子包。

示例

import { registerPluginHooksFromDir } from "openclaw/plugin-sdk";

export default function register(api) {
  registerPluginHooksFromDir(api, "./hooks");
}

注意事项：

• 钩子目录遵循正常的钩子结构（HOOK.md + handler.ts）。
• 钩子资格规则仍然适用（操作系统/二进制文件/环境/配置要求）。
• 插件管理的钩子会显示在 openclaw hooks list 中，并带有 plugin:<id>。
• 您不能通过 openclaw hooks 启用/禁用插件管理的钩子；请改为启用/禁用插件。

提供商插件（模型身份验证）

插件可以注册模型提供商身份验证流程，以便用户可以在 OAuth 内运行 API 或 OpenClaw 密钥设置（无需外部脚本）。

通过 api.registerProvider(...) 注册提供商。每个提供商公开一种或多种身份验证方法（OAuth、API 密钥、设备代码等）。这些方法支持：

• openclaw models auth login --provider <id> [--method <id>]

示例：

api.registerProvider({
  id: "acme",
  label: "AcmeAI",
  auth: [
    {
      id: "oauth",
      label: "OAuth",
      kind: "oauth",
      run: async (ctx) => {
        // Run OAuth flow and return auth profiles.
        return {
          profiles: [
            {
              profileId: "acme:default",
              credential: {
                type: "oauth",
                provider: "acme",
                access: "...",
                refresh: "...",
                expires: Date.now() + 3600 * 1000,
              },
            },
          ],
          defaultModel: "acme/opus-1",
        };
      },
    },
  ],
});

注意事项：

• run 接收一个 ProviderAuthContext，其中包含 prompter、runtime、 openUrl 和 oauth.createVpsAwareHandlers 辅助工具。
• 当您需要添加默认模型或提供商配置时，请返回 configPatch。
• 返回 defaultModel 以便 --set-default 更新代理默认值。

注册消息渠道

插件可以注册渠道插件，其行为类似于内置渠道（WhatsApp、Telegram 等）。渠道配置位于 channels.<id> 下，并由您的渠道插件代码进行验证。

const myChannel = {
  id: "acmechat",
  meta: {
    id: "acmechat",
    label: "AcmeChat",
    selectionLabel: "AcmeChat (API)",
    docsPath: "/channels/acmechat",
    blurb: "demo channel plugin.",
    aliases: ["acme"],
  },
  capabilities: { chatTypes: ["direct"] },
  config: {
    listAccountIds: (cfg) => Object.keys(cfg.channels?.acmechat?.accounts ?? {}),
    resolveAccount: (cfg, accountId) =>
      cfg.channels?.acmechat?.accounts?.[accountId ?? "default"] ?? {
        accountId,
      },
  },
  outbound: {
    deliveryMode: "direct",
    sendText: async () => ({ ok: true }),
  },
};

export default function (api) {
  api.registerChannel({ plugin: myChannel });
}

注意：

• 将配置置于 channels.<id> 下（而非 plugins.entries）。
• meta.label 用于 CLI/UI 列表中的标签。
• meta.aliases 添加用于规范化和 CLI 输入的备用 ID。
• meta.preferOver 列出在两者均已配置时跳过自动启用的渠道 ID。
• meta.detailLabel 和 meta.systemImage 允许 UI 显示更丰富的渠道标签/图标。

编写新的消息渠道（分步指南）

当您想要一个新的聊天界面（“消息渠道”）而非模型提供商时使用此选项。模型提供商文档位于 /providers/* 下。

1. 选择 ID + 配置结构

• 所有渠道配置均位于 channels.<id> 下。
• 对于多账户设置，首选 channels.<id>.accounts.<accountId>。

2. 定义渠道元数据

• meta.label、meta.selectionLabel、meta.docsPath、meta.blurb 控制 CLI/UI 列表。
• meta.docsPath 应指向类似于 /channels/<id> 的文档页面。
• meta.preferOver 允许插件替换另一个渠道（自动启用优先选择它）。
• meta.detailLabel 和 meta.systemImage 由 UI 用于详细文本/图标。

3. 实现所需的适配器

• config.listAccountIds + config.resolveAccount
• capabilities（聊天类型、媒体、会话串等）
• outbound.deliveryMode + outbound.sendText（用于基本发送）

4. 根据需要添加可选适配器

• setup (向导), security (私信策略), status (健康/诊断)
• gateway (启动/停止/登录), mentions, threading, streaming
• actions (消息操作), commands (原生命令行为)

5. 在插件中注册渠道

• api.registerChannel({ plugin })

最小配置示例：

{
  channels: {
    acmechat: {
      accounts: {
        default: { token: "ACME_TOKEN", enabled: true },
      },
    },
  },
}

最小渠道插件（仅限出站）：

const plugin = {
  id: "acmechat",
  meta: {
    id: "acmechat",
    label: "AcmeChat",
    selectionLabel: "AcmeChat (API)",
    docsPath: "/channels/acmechat",
    blurb: "AcmeChat messaging channel.",
    aliases: ["acme"],
  },
  capabilities: { chatTypes: ["direct"] },
  config: {
    listAccountIds: (cfg) => Object.keys(cfg.channels?.acmechat?.accounts ?? {}),
    resolveAccount: (cfg, accountId) =>
      cfg.channels?.acmechat?.accounts?.[accountId ?? "default"] ?? {
        accountId,
      },
  },
  outbound: {
    deliveryMode: "direct",
    sendText: async ({ text }) => {
      // deliver `text` to your channel here
      return { ok: true };
    },
  },
};

export default function (api) {
  api.registerChannel({ plugin });
}

加载插件（extensions 目录或 plugins.load.paths），重启网关， 然后在配置中配置 channels.<id>。

Agent 工具

请参阅专用指南：插件 Agent 工具。

注册 Gateway RPC 方法

export default function (api) {
  api.registerGatewayMethod("myplugin.status", ({ respond }) => {
    respond(true, { ok: true });
  });
}

注册 CLI 命令

export default function (api) {
  api.registerCli(
    ({ program }) => {
      program.command("mycmd").action(() => {
        console.log("Hello");
      });
    },
    { commands: ["mycmd"] },
  );
}

注册自动回复命令

插件可以注册自定义斜杠命令，这些命令执行时无需调用 AI 代理。这对于切换命令、状态检查或不需要 LLM 处理的快速操作非常有用。

export default function (api) {
  api.registerCommand({
    name: "mystatus",
    description: "Show plugin status",
    handler: (ctx) => ({
      text: `Plugin is running! Channel: ${ctx.channel}`,
    }),
  });
}

命令处理程序上下文：

• senderId：发送者的 ID（如果可用）
• channel：发送命令的渠道
• isAuthorizedSender：发送者是否为授权用户
• args：命令后传递的参数（如果 acceptsArgs: true）
• commandBody：完整的命令文本
• config: 当前的 OpenClaw 配置

命令选项：

• name：命令名称（不带前缀 /）
• description：在命令列表中显示的帮助文本
• acceptsArgs：命令是否接受参数（默认：false）。如果为 false 且提供了参数，该命令将不匹配，消息将传递给其他处理程序
• requireAuth：是否要求发送者已授权（默认：true）
• handler：返回 { text: string } 的函数（可以是异步的）

包含授权和参数的示例：

api.registerCommand({
  name: "setmode",
  description: "Set plugin mode",
  acceptsArgs: true,
  requireAuth: true,
  handler: async (ctx) => {
    const mode = ctx.args?.trim() || "default";
    await saveMode(mode);
    return { text: `Mode set to: ${mode}` };
  },
});

注意：

• 插件命令在内置命令和 AI 代理之前处理
• 命令是全局注册的，并在所有频道中工作
• 命令名称不区分大小写（/MyStatus 匹配 /mystatus）
• 命令名称必须以字母开头，且仅包含字母、数字、连字符和下划线
• 保留的命令名称（如 help、status、reset 等）不能被插件覆盖
• 跨插件重复注册命令将会失败，并返回诊断错误

注册后台服务

export default function (api) {
  api.registerService({
    id: "my-service",
    start: () => api.logger.info("ready"),
    stop: () => api.logger.info("bye"),
  });
}

命名约定

• Gateway(网关) 方法: pluginId.action (示例: voicecall.status)
• 工具：snake_case（例如：voice_call）
• CLI 命令: kebab 或 camel，但避免与核心命令冲突

Skills

插件可以在仓库中附带一个技能（skills/<name>/SKILL.md）。 通过 plugins.entries.<id>.enabled（或其他配置门控）启用它，并确保 它存在于您的工作区/托管技能位置中。

分发 (npm)

推荐的打包方式：

• 主包：openclaw（此仓库）
• 插件: @openclaw/* 下的独立 npm 包 (示例: @openclaw/voice-call)

发布约定：

• 插件 package.json 必须包含 openclaw.extensions，其中含有一个或多个入口文件。
• 入口文件可以是 .js 或 .ts（jiti 在运行时加载 TS）。
• openclaw plugins install <npm-spec> 使用 npm pack，将其提取到 ~/.openclaw/extensions/<id>/ 中，并在配置中启用它。
• 配置键稳定性：作用域包会被规范化为 plugins.entries.* 的 无作用域 id。

示例插件：语音通话

此仓库包含一个语音通话插件（Twilio 或日志回退）：

• 源码：extensions/voice-call
• 技能：skills/voice-call
• CLI: openclaw voicecall start|status
• 工具：voice_call
• RPC: voicecall.start, voicecall.status
• 配置 (twilio)：provider: "twilio" + twilio.accountSid/authToken/from (可选 statusCallbackUrl, twimlUrl)
• 配置 (dev)：provider: "log" (无网络)

请参阅 语音通话 和 extensions/voice-call/README.md 了解设置和用法。

安全说明

插件与 Gateway(网关) 网关在同一进程中运行。请将它们视为受信任的代码：

• 仅安装您信任的插件。
• 首选 plugins.allow 允许列表。
• 更改后重启 Gateway(网关) 网关。

测试插件

插件可以（并且应该）附带测试：

• 仓库内的插件可以将 Vitest 测试保存在 src/** 下（示例：src/plugins/voice-call.plugin.test.ts）。
• 单独发布的插件应运行自己的 CI (lint/build/test) 并验证 openclaw.extensions 指向构建的入口点 (dist/index.js)。