Plugin のエントリーポイント

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​

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は初回アクセス時にそのスキーマを解決してメモ化するため、コストの高いスキーマビルダーは一度だけ実行されます。

​

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メタデータのキャプチャ中はスキップされます。
• registerCliMetadata は api.registrationMode === "cli-metadata"、api.registrationMode === "discovery"、および api.registrationMode === "full" の間に実行されます。 チャネル所有のCLIディスクリプターの標準的な場所として使用してください。これにより、ルートヘルプは非アクティブ化のままになり、検出スナップショットには静的コマンドメタデータが含まれ、通常のCLIコマンド登録は完全なPlugin読み込みと互換性を保ちます。
• 検出登録は非アクティブ化ですが、インポートなしではありません。OpenClawはスナップショットを構築するために、信頼済みPluginエントリとチャネルPluginモジュールを評価する場合があります。そのため、トップレベルのインポートには副作用がないようにし、ソケット、クライアント、ワーカー、サービスは "full" のみのパスの背後に置いてください。
• registerFull は api.registrationMode === "full" の場合にのみ実行されます。セットアップ専用読み込み中はスキップされます。
• definePluginEntry と同様に、configSchema は遅延ファクトリにでき、OpenClawは初回アクセス時に解決済みスキーマをメモ化します。
• Plugin所有のルートCLIコマンドでは、ルートCLI解析ツリーから消えずにコマンドを遅延読み込みのままにしたい場合、api.registerCli(..., { descriptors: [...] }) を優先してください。ペアノード機能コマンドでは、コマンドが openclaw nodes の下に配置されるように api.registerNodeCliFeature(...) を優先してください。その他のネストされたPluginコマンドでは、parentPath を追加し、レジストラーに渡された program オブジェクトにコマンドを登録してください。OpenClawはPluginを呼び出す前にそれを親コマンドへ解決します。チャネルPluginでは、それらのディスクリプターを registerCliMetadata(...) から登録し、registerFull(...) はランタイム専用の作業に集中させることを優先してください。
• registerFull(...) がGateway RPCメソッドも登録する場合、それらはPlugin固有のプレフィックス上に置いてください。予約済みのコア管理名前空間（config.*、exec.approvals.*、wizard.*、update.*）は常に operator.admin に強制されます。

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• インポート安全なセットアップパッチアダプター、lookup-note出力、promptResolvedAllowFrom、splitSetupEntries、委譲セットアッププロキシなどのランタイム安全なセットアップヘルパーには openclaw/plugin-sdk/setup-runtime
• 任意インストールのセットアップサーフェスには openclaw/plugin-sdk/channel-setup
• セットアップ/インストールCLI/アーカイブ/docsヘルパーには openclaw/plugin-sdk/setup-tools

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",
  },
});

​

登録モード

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

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

  // Heavy runtime-only registrations
  api.registerService(/* ... */);
}

• registrar が 1 つ以上のルートコマンドを所有していて、最初の呼び出し時に OpenClaw に実際の CLI モジュールを遅延読み込みさせたい場合は、descriptors を使用する
• それらの descriptor が、registrar によって公開されるすべてのトップレベルコマンドルートをカバーしていることを確認する
• descriptor のコマンド名は、英字、数字、ハイフン、アンダースコアのみにし、英字または数字で始める。OpenClaw はこの形から外れる descriptor 名を拒否し、ヘルプをレンダリングする前に説明から端末制御シーケンスを取り除く
• 即時読み込みの互換性パスにのみ commands 単体を使用する

​

Plugin の形態

​

関連

• SDK の概要 - 登録 API とサブパスリファレンス
• ランタイムヘルパー - api.runtime と createPluginRuntimeStore
• セットアップと設定 - manifest、セットアップエントリ、遅延読み込み
• Channel Plugins - ChannelPlugin オブジェクトの構築
• Provider Plugins - provider 登録と hook