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 コア開発者向けの コントリビューターガイド です。外部 Plugin を
構築している場合は、代わりに Plugin の構築
を参照してください。詳細なアーキテクチャリファレンス(ケイパビリティモデル、所有権、
ロードパイプライン、ランタイムヘルパー)については、Plugin 内部構造 を参照してください。
- plugin = 所有権境界
- capability = 共有コアコントラクト
ケイパビリティを作成するタイミング
次の すべて が当てはまる場合に、新しいケイパビリティを作成します。- 複数のベンダーがそれを実装できる可能性がある。
- チャネル、ツール、または機能 Plugin が、ベンダーを意識せずにそれを利用できるべきである。
- コアがフォールバック、ポリシー、設定、または配信動作を所有する必要がある。
標準的な順序
- 型付きのコアコントラクトを定義する。
- そのコントラクト用の Plugin 登録を追加する。
- 共有ランタイムヘルパーを追加する。
- 実証として実際のベンダー Plugin を 1 つ接続する。
- 機能/チャネルの利用側をランタイムヘルパーに移行する。
- コントラクトテストを追加する。
- オペレーター向けの設定と所有権モデルを文書化する。
何をどこに置くか
コア:- リクエスト/レスポンス型。
- プロバイダーレジストリと解決。
- フォールバック動作。
- ネストされたオブジェクト、ワイルドカード、配列アイテム、合成ノードに伝播された
title/descriptionドキュメントメタデータを持つ設定スキーマ。 - ランタイムヘルパーのサーフェス。
- ベンダー API 呼び出し。
- ベンダー認証処理。
- ベンダー固有のリクエスト正規化。
- ケイパビリティ実装の登録。
api.runtime.*または対応するplugin-sdk/*-runtimeヘルパーを呼び出す。- ベンダー実装を直接呼び出してはならない。
プロバイダーとハーネスの継ぎ目
動作が汎用エージェントループではなくモデルプロバイダーコントラクトに属する場合は、プロバイダーフック を使用します。例には、トランスポート選択後のプロバイダー固有リクエストパラメーター、認証プロファイルの優先、プロンプトオーバーレイ、モデル/プロファイルのフェイルオーバー後のフォローアップフォールバックルーティングが含まれます。 動作がターンを実行しているランタイムに属する場合は、エージェントハーネスフック を使用します。ハーネスは、空、推論のみ、計画のみのレスポンスなど、成功したが使用できない試行結果を分類できるため、外側のモデルフォールバックポリシーが再試行の判断を行えます。 両方の継ぎ目は狭く保ちます。- コアが再試行/フォールバックポリシーを所有する。
- プロバイダー Plugin がプロバイダー固有のリクエスト/認証/ルーティングのヒントを所有する。
- ハーネス Plugin がランタイム固有の試行分類を所有する。
- サードパーティ Plugin は、コア状態の直接変更ではなくヒントを返す。
ファイルチェックリスト
新しいケイパビリティでは、次の領域に触れることを想定してください。src/<capability>/types.tssrc/<capability>/...registry/runtime.tssrc/plugins/types.tssrc/plugins/registry.tssrc/plugins/captured-registration.tssrc/plugins/contracts/registry.tssrc/plugins/runtime/types-core.tssrc/plugins/runtime/index.tssrc/plugin-sdk/<capability>.tssrc/plugin-sdk/<capability>-runtime.ts- 1 つ以上のバンドル済み Plugin パッケージ。
- 設定、ドキュメント、テスト。
実例: 画像生成
画像生成は標準的な形に従います。- コアが
ImageGenerationProviderを定義する。 - コアが
registerImageGenerationProvider(...)を公開する。 - コアが
runtime.imageGeneration.generate(...)を公開する。 openai、google、fal、minimaxの Plugin がベンダー支援実装を登録する。- 将来のベンダーは、チャネル/ツールを変更せずに同じコントラクトを登録する。
agents.defaults.imageModelは画像を分析する。agents.defaults.imageGenerationModelは画像を生成する。
レビューチェックリスト
新しいケイパビリティを出荷する前に、次を確認してください。- チャネル/ツールがベンダーコードを直接インポートしていない。
- ランタイムヘルパーが共有パスである。
- 少なくとも 1 つのコントラクトテストがバンドル済み所有権をアサートしている。
- 設定ドキュメントが新しいモデル/設定キーの名前を示している。
- Plugin ドキュメントが所有権境界を説明している。
関連
- Plugin 内部構造 — ケイパビリティモデル、所有権、ロードパイプライン、ランタイムヘルパー。
- Plugin の構築 — 最初の Plugin チュートリアル。
- SDK 概要 — インポートマップと登録 API リファレンス。
- Skills の作成 — 関連するコントリビューター向けサーフェス。