​

プラグインのエントリーポイント

​

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 マニフェストと一致している必要があります。
• kind は排他的スロット用です: "memory" または "context-engine"。
• configSchema は遅延評価のために関数にできます。
• OpenClaw はそのスキーマを初回アクセス時に解決してメモ化するため、高コストなスキーマ ビルダーは 1 回しか実行されません。

​

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 は登録中に呼び出されるため、ランタイム参照を保存できます （通常は createPluginRuntimeStore を使います）。CLI metadata の 取得中はスキップされます。
• registerCliMetadata は api.registrationMode === "cli-metadata" と api.registrationMode === "full" の両方で実行されます。 ルートヘルプを非アクティブのまま保ちつつ、通常の CLI コマンド登録を full plugin load と互換に保つため、 チャンネル所有の CLI descriptor の正規の置き場所としてこれを使ってください。
• registerFull は api.registrationMode === "full" のときだけ実行されます。setup-only の読み込み中はスキップされます。
• definePluginEntry と同様に、configSchema は遅延ファクトリーにでき、 OpenClaw は解決済みスキーマを初回アクセス時にメモ化します。
• プラグイン所有のルート CLI コマンドでは、コマンドを ルート CLI parse tree から消さずに lazy-load のままにしたい場合、 api.registerCli(..., { descriptors: [...] }) を優先してください。channel plugin では、 それらの descriptor は registerCliMetadata(...) から登録し、registerFull(...) はランタイム専用の処理に集中させてください。
• registerFull(...) が gateway RPC method も登録する場合は、それらを plugin 固有の prefix に保ってください。予約済みの core admin namespace（config.*、 exec.approvals.*、wizard.*、update.*）は常に operator.admin に強制されます。

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime は、import-safe な setup patch adapter、 lookup-note 出力、 promptResolvedAllowFrom、splitSetupEntries、委譲 setup proxy などの ランタイムセーフな setup helper 用
• openclaw/plugin-sdk/channel-setup は任意インストールの setup surface 用
• openclaw/plugin-sdk/setup-tools は setup / install CLI / archive / docs helper 用

​

登録モード

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

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

  // 重いランタイム専用の登録
  api.registerService(/* ... */);
}

• registrar が 1 つ以上のルートコマンドを所有し、 最初の呼び出し時に OpenClaw に実際の CLI module を lazy-load させたい場合は descriptors を使ってください
• それらの descriptor が、その registrar によって公開されるすべてのトップレベルコマンド root をカバーしていることを確認してください
• commands 単独は eager な互換パスにのみ使ってください

​

プラグイン形状

​

関連

• SDK Overview — 登録 API と subpath リファレンス
• Runtime Helpers — api.runtime と createPluginRuntimeStore
• Setup and Config — マニフェスト、setup entry、遅延読み込み
• Channel Plugins — ChannelPlugin オブジェクトの構築
• Provider Plugins — provider 登録と hook