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",  "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/[email protected]",      "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",      "defaultChoice": "npm"    }  }}

完全読み込みの遅延

Channel plugins は、次の設定で遅延読み込みを有効にできます:

{  "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 plugins の場合は、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 ファイルは index.ts の軽量な代替で、OpenClaw がセットアップサーフェス（オンボーディング、設定修復、無効化されたチャネルの検査）だけを必要とするときに読み込みます。

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

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

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

狭いセットアップヘルパーのインポート

セットアップ専用のホットパスでは、セットアップサーフェスの一部だけが必要な場合、より広範な plugin-sdk/setup アンブレラよりも狭いセットアップヘルパーの継ぎ目を優先してください。

moveSingleAccountChannelSectionToDefaultAccount(...) などの設定パッチヘルパーを含む、完全な共有セットアップツールボックスが必要な場合は、より広範な plugin-sdk/setup の継ぎ目を使用してください。

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

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

チャネルが単一アカウントのトップレベル設定から 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 }

公開とインストール

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

openclaw plugins install @myorg/openclaw-my-plugin

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

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

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

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

openclaw plugins install <package-name>

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

関連

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