Plugin のセットアップと設定

Plugin のパッケージング（package.json メタデータ）、マニフェスト（openclaw.plugin.json）、セットアップエントリ、設定スキーマのリファレンス。

パッケージメタデータ

package.json には、Plugin システムに Plugin が何を提供するかを伝える openclaw フィールドが必要です。

{  "name": "@myorg/openclaw-my-channel",  "version": "1.0.0",  "type": "module",  "openclaw": {    "extensions": ["./index.ts"],    "setupEntry": "./setup-entry.ts",    "channel": {      "id": "my-channel",      "label": "My Channel",      "blurb": "Short description of the channel."    }  }}

{  "name": "@myorg/openclaw-my-plugin",  "version": "1.0.0",  "type": "module",  "dependencies": {    "typebox": "1.1.39"  },  "peerDependencies": {    "openclaw": ">=2026.3.24-beta.2"  },  "openclaw": {    "extensions": ["./index.ts"],    "compat": {      "pluginApi": ">=2026.3.24-beta.2",      "minGatewayVersion": "2026.3.24-beta.2"    },    "build": {      "openclawVersion": "2026.3.24-beta.2",      "pluginSdkVersion": "2026.3.24-beta.2"    }  }}

openclaw フィールド

openclaw.channel

openclaw.channel は、ランタイムが読み込まれる前のチャネル検出とセットアップ画面向けの低コストなパッケージメタデータです。

例:

{  "openclaw": {    "channel": {      "id": "my-channel",      "label": "My Channel",      "selectionLabel": "My Channel (self-hosted)",      "detailLabel": "My Channel Bot",      "docsPath": "/channels/my-channel",      "docsLabel": "my-channel",      "blurb": "Webhook-based self-hosted chat integration.",      "order": 80,      "aliases": ["mc"],      "preferOver": ["my-channel-legacy"],      "selectionDocsPrefix": "Guide:",      "selectionExtras": ["Markdown"],      "markdownCapable": true,      "exposure": {        "configured": true,        "setup": true,        "docs": true      },      "quickstartAllowFrom": true    }  }}

exposure は次をサポートします。

• configured: 設定済み/ステータス形式の一覧画面にチャネルを含める
• setup: 対話型セットアップ/設定ピッカーにチャネルを含める
• docs: ドキュメント/ナビゲーション画面でチャネルを公開向けとしてマークする

openclaw.install

openclaw.install はパッケージメタデータであり、マニフェストメタデータではありません。

{  "openclaw": {    "install": {      "npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3",      "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",      "defaultChoice": "npm"    }  }}

遅延フルロード

Channel Plugin は、次で遅延読み込みを選択できます。

{  "openclaw": {    "extensions": ["./index.ts"],    "setupEntry": "./setup-entry.ts",    "startup": {      "deferConfiguredChannelFullLoadUntilAfterListen": true    }  }}

有効にすると、OpenClaw はすでに設定済みのチャネルであっても、listen 前の起動フェーズでは setupEntry だけを読み込みます。完全なエントリは Gateway が listen を開始した後に読み込まれます。

セットアップ/完全エントリが Gateway RPC メソッドを登録する場合は、Plugin 固有のプレフィックスに置いてください。予約済みのコア管理名前空間（config.*、exec.approvals.*、wizard.*、update.*）はコア所有のままで、常に operator.admin に解決されます。

Plugin マニフェスト

すべてのネイティブ Plugin は、パッケージルートに openclaw.plugin.json を同梱する必要があります。OpenClaw はこれを使って、Plugin コードを実行せずに設定を検証します。

{  "id": "my-plugin",  "name": "My Plugin",  "description": "Adds My Plugin capabilities to OpenClaw",  "configSchema": {    "type": "object",    "additionalProperties": false,    "properties": {      "webhookSecret": {        "type": "string",        "description": "Webhook verification secret"      }    }  }}

Channel Plugin では、kind と channels を追加します。

{  "id": "my-channel",  "kind": "channel",  "channels": ["my-channel"],  "configSchema": {    "type": "object",    "additionalProperties": false,    "properties": {}  }}

構成がない Plugin でもスキーマを同梱する必要があります。空のスキーマは有効です。

{  "id": "my-plugin",  "configSchema": {    "type": "object",    "additionalProperties": false  }}

完全なスキーマリファレンスについては、Plugin マニフェストを参照してください。

ClawHub への公開

Plugin パッケージでは、パッケージ専用の ClawHub コマンドを使用します。

clawhub package publish your-org/your-plugin --dry-runclawhub package publish your-org/your-plugin

セットアップエントリ

setup-entry.ts ファイルは、OpenClaw がセットアップサーフェス（オンボーディング、構成修復、無効化されたチャンネルの検査）だけを必要とする場合に読み込む、index.ts の軽量な代替です。

// setup-entry.ts  export default defineSetupPluginEntry(myChannelPlugin);

これにより、セットアップフロー中に重いランタイムコード（暗号ライブラリ、CLI 登録、バックグラウンドサービス）を読み込まずに済みます。

セットアップに安全なエクスポートをサイドカーモジュールに保持しているバンドル済みワークスペースチャンネルは、defineSetupPluginEntry(...) の代わりに openclaw/plugin-sdk/channel-entry-contract の defineBundledChannelSetupEntry(...) を使用できます。そのバンドル済み契約は任意の runtime エクスポートにも対応しているため、セットアップ時のランタイム配線を軽量かつ明示的に保てます。

狭いセットアップヘルパー import

セットアップ専用のホットパスでは、セットアップサーフェスの一部だけが必要な場合、広範な plugin-sdk/setup 包括エントリではなく、狭いセットアップヘルパーの継ぎ目を優先します。

moveSingleAccountChannelSectionToDefaultAccount(...) などの構成パッチヘルパーを含む、共有セットアップツールボックス全体が必要な場合は、より広範な plugin-sdk/setup の継ぎ目を使用します。

固定のセットアップウィザード文言には createSetupTranslator(...) を使用します。これは CLI ウィザードのロケール（OPENCLAW_LOCALE、次にシステムロケール変数）に従い、 英語にフォールバックします。Plugin 固有のセットアップテキストは Plugin 所有のコードに保持し、 共通のセットアップラベル、ステータステキスト、公式バンドル Plugin のセットアップ文言にのみ 共有カタログキーを使用します。

セットアップパッチアダプターは、import 時もホットパス安全です。バンドル済み単一アカウント昇格の契約サーフェス検索は遅延されるため、plugin-sdk/setup-runtime を import しても、アダプターが実際に使用される前にバンドル済み契約サーフェス探索が即時読み込みされることはありません。

チャンネル所有の単一アカウント昇格

チャンネルが単一アカウントのトップレベル構成から channels.<id>.accounts.* にアップグレードする場合、デフォルトの共有動作では、昇格されたアカウントスコープの値を accounts.default に移動します。

バンドル済みチャンネルは、セットアップ契約サーフェスを通じてその昇格を絞り込む、または上書きできます。

• singleAccountKeysToMove: 昇格されたアカウントへ移動する必要がある追加のトップレベルキー
• namedAccountPromotionKeys: 名前付きアカウントがすでに存在する場合、これらのキーだけが昇格されたアカウントへ移動します。共有ポリシー/配信キーはチャンネルルートに残ります
• resolveSingleAccountPromotionTarget(...): 昇格された値を受け取る既存アカウントを選択します

構成スキーマ

Plugin 構成は、マニフェスト内の JSON Schema に対して検証されます。ユーザーは次のように Plugin を構成します。

{  plugins: {    entries: {      "my-plugin": {        config: {          webhookSecret: "abc123",        },      },    },  },}

Plugin は登録中にこの構成を api.pluginConfig として受け取ります。

チャンネル固有の構成には、代わりにチャンネル構成セクションを使用します。

{  channels: {    "my-channel": {      token: "bot-token",      allowFrom: ["user1", "user2"],    },  },}

チャンネル構成スキーマの構築

buildChannelConfigSchema を使用して、Zod スキーマを Plugin 所有の構成アーティファクトで使用される ChannelConfigSchema ラッパーに変換します。

  const accountSchema = z.object({  token: z.string().optional(),  allowFrom: z.array(z.string()).optional(),  accounts: z.object({}).catchall(z.any()).optional(),  defaultAccount: z.string().optional(),}); const configSchema = buildChannelConfigSchema(accountSchema);

契約をすでに JSON Schema または TypeBox として作成している場合は、メタデータパスで OpenClaw が Zod から JSON Schema への変換を省略できるよう、直接ヘルパーを使用します。

  const configSchema = buildJsonChannelConfigSchema(  Type.Object({    token: Type.Optional(Type.String()),    allowFrom: Type.Optional(Type.Array(Type.String())),  }),);

サードパーティ Plugin では、コールドパス契約は引き続き Plugin マニフェストです。生成された JSON Schema を openclaw.plugin.json#channelConfigs にミラーリングして、構成スキーマ、セットアップ、UI サーフェスがランタイムコードを読み込まずに channels.<id> を検査できるようにします。

セットアップウィザード

チャンネル Plugin は openclaw onboard 用の対話型セットアップウィザードを提供できます。ウィザードは ChannelPlugin 上の ChannelSetupWizard オブジェクトです。

 const setupWizard: ChannelSetupWizard = {  channel: "my-channel",  status: {    configuredLabel: "Connected",    unconfiguredLabel: "Not configured",    resolveConfigured: ({ cfg }) => Boolean((cfg.channels as any)?.["my-channel"]?.token),  },  credentials: [    {      inputKey: "token",      providerHint: "my-channel",      credentialLabel: "Bot token",      preferredEnvVar: "MY_CHANNEL_BOT_TOKEN",      envPrompt: "Use MY_CHANNEL_BOT_TOKEN from environment?",      keepPrompt: "Keep current token?",      inputPrompt: "Enter your bot token:",      inspect: ({ cfg, accountId }) => {        const token = (cfg.channels as any)?.["my-channel"]?.token;        return {          accountConfigured: Boolean(token),          hasConfiguredValue: Boolean(token),        };      },    },  ],};

ChannelSetupWizard 型は、credentials、textInputs、dmPolicy、allowFrom、groupAccess、prepare、finalize などをサポートします。完全な例については、バンドル済み Plugin パッケージ（たとえば Discord Plugin の src/channel.setup.ts）を参照してください。

import { createOptionalChannelSetupSurface } from "openclaw/plugin-sdk/channel-setup"; const setupSurface = createOptionalChannelSetupSurface({  channel: "my-channel",  label: "My Channel",  npmSpec: "@myorg/openclaw-my-channel",  docsPath: "/channels/my-channel",});// Returns { setupAdapter, setupWizard }

公開とインストール

外部プラグイン: ClawHub に公開してから、インストールします。

openclaw plugins install @myorg/openclaw-my-plugin

openclaw plugins install clawhub:@myorg/openclaw-my-plugin

openclaw plugins install npm:@myorg/openclaw-my-plugin

リポジトリ内プラグイン: バンドル済みプラグインのワークスペースツリー配下に配置すると、ビルド時に自動検出されます。

ユーザーは次のようにインストールできます。

openclaw plugins install <package-name>

バンドル済みパッケージのメタデータは明示的であり、Gateway 起動時にビルド済み JavaScript から推論されるものではありません。ランタイム依存関係は、それを所有するプラグインパッケージに属します。パッケージ化された OpenClaw の起動処理がプラグインの依存関係を修復またはミラーすることはありません。

関連

• プラグインの構築 — 段階的なはじめにガイド
• Plugin マニフェスト — 完全なマニフェストスキーマリファレンス
• SDK エントリポイント — definePluginEntry と defineChannelPluginEntry