プラグイン(拡張機能)
クイックスタート(プラグインが初めての方)
プラグインは、OpenClaw を追加機能(コマンド、ツール、Gateway RPC)で拡張する 小さなコードモジュール です。 多くの場合、コアの OpenClaw にはまだ組み込まれていない機能が必要なとき(または任意機能をメインのインストールから分離したいとき)にプラグインを使用します。 高速パス:- すでにロードされているものを確認します:
- 公式プラグインをインストールします(例:Voice Call):
- Gateway を再起動し、
plugins.entries.<id>.config配下で設定します。
利用可能なプラグイン(公式)
- Microsoft Teams は 2026.1.15 時点でプラグイン専用です。Teams を使用する場合は
@openclaw/msteamsをインストールしてください。 - Memory(Core)— 同梱のメモリ検索プラグイン(
plugins.slots.memoryにより既定で有効) - Memory(LanceDB)— 同梱の長期記憶プラグイン(自動リコール/キャプチャ。
plugins.slots.memory = "memory-lancedb"を設定) - Voice Call —
@openclaw/voice-call - Zalo Personal —
@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デバイスログインとは別(同梱、既定で無効)
- Gateway RPC メソッド
- Gateway HTTP ハンドラー
- エージェントツール
- CLI コマンド
- バックグラウンドサービス
- 任意の設定検証
- Skills(プラグインマニフェストに
skillsディレクトリを列挙) - 自動返信コマンド(AI エージェントを呼び出さずに実行)
ランタイムヘルパー
プラグインは、api.runtime を介して選択されたコアヘルパーにアクセスできます。電話向け TTS の場合:
- コアの
messages.tts設定(OpenAI または ElevenLabs)を使用します。 - PCM オーディオバッファとサンプルレートを返します。プロバイダー向けの再サンプリング/エンコードはプラグイン側で行ってください。
- Edge TTS は電話には対応していません。
検出と優先順位
OpenClaw は次の順序でスキャンします:- 設定パス
plugins.load.paths(ファイルまたはディレクトリ)
- ワークスペース拡張
<workspace>/.openclaw/extensions/*.ts<workspace>/.openclaw/extensions/*/index.ts
- グローバル拡張
~/.openclaw/extensions/*.ts~/.openclaw/extensions/*/index.ts
- 同梱拡張(OpenClaw とともに配布、既定で無効)
<openclaw>/extensions/*
plugins.entries.<id>.enabled
または openclaw plugins enable <id> により明示的に有効化する必要があります。インストール済みプラグインは既定で有効ですが、同じ方法で無効化できます。
各プラグインは、ルートに openclaw.plugin.json ファイルを含める必要があります。パスがファイルを指す場合、プラグインのルートはそのファイルのディレクトリであり、マニフェストを含んでいる必要があります。
同じ id に解決されるプラグインが複数ある場合、上記順序で最初に一致したものが優先され、低優先度のコピーは無視されます。
パッケージパック
プラグインディレクトリには、openclaw.extensions を含む package.json を含めることができます:
name/<fileBase> になります。
プラグインが npm 依存関係を import する場合は、そのディレクトリにインストールして node_modules が利用可能であることを確認してください(npm install / pnpm install)。
セキュリティ注意: openclaw plugins install はプラグイン依存関係を
npm install --ignore-scripts でインストールします(ライフサイクルスクリプトは実行されません)。依存関係ツリーは「pure JS/TS」に保ち、postinstall ビルドを必要とするパッケージは避けてください。
チャンネルカタログのメタデータ
チャンネルプラグインは、openclaw.channel によりオンボーディング用メタデータを、openclaw.install によりインストールヒントを告知できます。これにより、コアのカタログをデータフリーに保てます。
例:
~/.openclaw/mpm/plugins.json~/.openclaw/mpm/catalog.json~/.openclaw/plugins/catalog.json
OPENCLAW_PLUGIN_CATALOG_PATHS(または OPENCLAW_MPM_CATALOG_PATHS)を 1 つ以上の JSON ファイル(カンマ/セミコロン/PATH 区切り)に指定します。各ファイルは{ "entries": [ { "name": "@scope/pkg", "openclaw": { "channel": {...}, "install": {...} } } ] }を含める必要があります。
プラグイン ID
既定のプラグイン id:- パッケージパック:
package.jsonのname - 単体ファイル:ファイルのベース名(
~/.../voice-call.ts→voice-call)
id をエクスポートしている場合、OpenClaw はそれを使用しますが、設定された id と一致しない場合は警告します。
設定
enabled: マスタートグル(既定: true)allow: 許可リスト(任意)deny: 拒否リスト(任意。拒否が優先)load.paths: 追加のプラグインファイル/ディレクトリentries.<id>: プラグインごとのトグル + 設定
entries、allow、deny、またはslotsに未知のプラグイン id がある場合は エラー。- 未知の
channels.<id>キーは、プラグインマニフェストがチャンネル id を宣言していない限り エラー。 - プラグイン設定は、
openclaw.plugin.json(configSchema)に埋め込まれた JSON Schema を用いて検証されます。 - プラグインが無効な場合でも設定は保持され、警告 が出力されます。
プラグインスロット(排他カテゴリ)
一部のプラグインカテゴリは 排他(同時に 1 つのみ有効)です。どのプラグインがスロットを所有するかはplugins.slots で選択します:
kind: "memory" を宣言している場合、選択されたもののみがロードされ、他は診断付きで無効化されます。
コントロール UI(スキーマ + ラベル)
コントロール UI は、config.schema(JSON Schema + uiHints)を使用して、より良いフォームを描画します。
OpenClaw は、検出されたプラグインに基づき、実行時に uiHints を拡張します:
plugins.entries.<id>/.enabled/.configのプラグイン別ラベルを追加- 次の配下に、プラグイン提供の任意の設定フィールドヒントをマージ:
plugins.entries.<id>.config.<field>
uiHints を提供してください。
例:
CLI
plugins update は、plugins.installs 配下で追跡されている npm インストールにのみ対応します。
プラグインは、独自のトップレベルコマンドを登録することもできます(例:openclaw voicecall)。
プラグイン API(概要)
プラグインは次のいずれかをエクスポートします:- 関数:
(api) => { ... } - オブジェクト:
{ id, name, configSchema, register(api) { ... } }
プラグインフック
プラグインはフックを同梱し、実行時に登録できます。これにより、別途フックパックをインストールせずに、イベント駆動の自動化をバンドルできます。例
- フックディレクトリは通常のフック構造(
HOOK.md+handler.ts)に従います。 - フックの適格性ルール(OS/バイナリ/環境変数/設定要件)は引き続き適用されます。
- プラグイン管理フックは、
plugin:<id>付きでopenclaw hooks listに表示されます。 openclaw hooksからプラグイン管理フックを有効/無効にすることはできません。代わりにプラグイン自体を有効/無効にしてください。
プロバイダープラグイン(モデル認証)
プラグインは モデルプロバイダー認証 フローを登録でき、ユーザーは OpenClaw 内で OAuth や API キー設定を実行できます(外部スクリプト不要)。api.registerProvider(...) によりプロバイダーを登録します。各プロバイダーは 1 つ以上の認証方法(OAuth、API キー、デバイスコードなど)を公開します。これらの方法は次を提供します:
openclaw models auth login --provider <id> [--method <id>]
runは、prompter、runtime、openUrl、oauth.createVpsAwareHandlersヘルパーを備えたProviderAuthContextを受け取ります。- 既定モデルやプロバイダー設定を追加する必要がある場合は
configPatchを返してください。 --set-defaultがエージェントの既定値を更新できるように、defaultModelを返してください。
メッセージングチャンネルの登録
プラグインは、組み込みチャンネル(WhatsApp、Telegram など)のように振る舞う チャンネルプラグイン を登録できます。チャンネル設定はchannels.<id> 配下に置かれ、チャンネルプラグインのコードで検証されます。
- 設定は
channels.<id>配下に置いてください(plugins.entriesではありません)。 meta.labelは、CLI/UI リストのラベルに使用されます。meta.aliasesは、正規化および CLI 入力のための代替 id を追加します。meta.preferOverは、両方が設定されている場合に自動有効化をスキップするチャンネル id を列挙します。meta.detailLabelとmeta.systemImageにより、UI でよりリッチなチャンネルのラベル/アイコンを表示できます。
新しいメッセージングチャンネルの作成(ステップバイステップ)
新しいチャットの受け皿(「メッセージングチャンネル」)が必要な場合に使用してください。モデルプロバイダーではありません。モデルプロバイダーのドキュメントは/providers/* にあります。
- id と設定形状を選択
- すべてのチャンネル設定は
channels.<id>配下に置きます。 - マルチアカウント構成には
channels.<id>.accounts.<accountId>を推奨します。
- チャンネルメタデータを定義
meta.label、meta.selectionLabel、meta.docsPath、meta.blurbは CLI/UI リストを制御します。meta.docsPathは、/channels/<id>のようなドキュメントページを指す必要があります。meta.preferOverにより、プラグインが別のチャンネルを置き換えられます(自動有効化はそれを優先)。meta.detailLabelとmeta.systemImageは、UI の詳細テキスト/アイコンに使用されます。
- 必須アダプターを実装
config.listAccountIds+config.resolveAccountcapabilities(チャット種別、メディア、スレッドなど)outbound.deliveryMode+outbound.sendText(基本的な送信)
- 必要に応じて任意アダプターを追加
setup(ウィザード)、security(DM ポリシー)、status(ヘルス/診断)gateway(開始/停止/ログイン)、mentions、threading、streamingactions(メッセージアクション)、commands(ネイティブコマンドの挙動)
- プラグインでチャンネルを登録
api.registerChannel({ plugin })
plugins.load.paths)し、Gateway を再起動してから、設定で channels.<id> を構成してください。
エージェントツール
専用ガイドを参照してください:Plugin agent tools。Gateway RPC メソッドの登録
CLI コマンドの登録
自動返信コマンドの登録
プラグインは、AI エージェントを呼び出さずに 実行されるカスタムのスラッシュコマンドを登録できます。トグル、ステータス確認、LLM 処理を必要としないクイックアクションに有用です。senderId: 送信者の ID(利用可能な場合)channel: コマンドが送信されたチャンネルisAuthorizedSender: 送信者が許可されたユーザーかどうかargs: コマンド後に渡された引数(acceptsArgs: trueの場合)commandBody: 完全なコマンドテキストconfig: 現在の OpenClaw 設定
name: コマンド名(先頭の/なし)description: コマンド一覧に表示されるヘルプテキストacceptsArgs: 引数を受け付けるか(既定: false)。false で引数が指定された場合、コマンドは一致せず、メッセージは他のハンドラーにフォールスルーしますrequireAuth: 許可された送信者を要求するか(既定: true)handler:{ text: string }を返す関数(async 可)
- プラグインコマンドは、組み込みコマンドおよび AI エージェント より前 に処理されます。
- コマンドはグローバルに登録され、すべてのチャンネルで機能します。
- コマンド名は大文字小文字を区別しません(
/MyStatusは/mystatusに一致)。 - コマンド名は文字で始まり、文字・数字・ハイフン・アンダースコアのみを含める必要があります。
- 予約済みのコマンド名(
help,status,reset, etc.)はプラグインで上書きできません。 - プラグイン間で重複するコマンド登録は、診断エラーで失敗します。
バックグラウンドサービスの登録
命名規約
- Gateway メソッド:
pluginId.action(例:voicecall.status) - ツール:
snake_case(例:voice_call) - CLI コマンド: kebab または camel。ただし、コアコマンドとの衝突は避けてください。
Skills
プラグインは、リポジトリ内にスキル(skills/<name>/SKILL.md)を同梱できます。plugins.entries.<id>.enabled(または他の設定ゲート)で有効化し、ワークスペース/管理された Skills の配置場所に存在することを確認してください。
配布(npm)
推奨パッケージング:- メインパッケージ:
openclaw(このリポジトリ) - プラグイン:
@openclaw/*配下の個別 npm パッケージ(例:@openclaw/voice-call)
- プラグインの
package.jsonには、1 つ以上のエントリーファイルを含むopenclaw.extensionsが必要です。 - エントリーファイルは
.jsまたは.tsにできます(jiti は実行時に TS をロードします)。 openclaw plugins install <npm-spec>はnpm packを使用し、~/.openclaw/extensions/<id>/に展開して、有効化します。- 設定キーの安定性: スコープ付きパッケージは、
plugins.entries.*では 非スコープ id に正規化されます。
例: Voice Call プラグイン
このリポジトリには、音声通話プラグイン(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 を再起動してください。
プラグインのテスト
プラグインは(可能であれば)テストを同梱してください:- リポジトリ内プラグインは、
src/**配下に Vitest テストを配置できます(例:src/plugins/voice-call.plugin.test.ts)。 - 別途公開するプラグインは、独自の CI(lint/build/test)を実行し、
openclaw.extensionsがビルド済みエントリーポイント(dist/index.js)を指していることを検証してください。