メインコンテンツへスキップ

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.

TypeBox は TypeScript ファーストのスキーマライブラリです。これを使って Gateway WebSocket プロトコル（ハンドシェイク、リクエスト/レスポンス、サーバーイベント）を定義しています。これらのスキーマは、macOS アプリ向けの ランタイム検証、JSON Schema エクスポート、Swift コード生成を駆動します。信頼できる情報源は 1 つで、それ以外はすべて生成されます。 より上位のプロトコルコンテキストを知りたい場合は、 Gatewayアーキテクチャ から始めてください。

​
メンタルモデル（30 秒）

すべての Gateway WS メッセージは、次の 3 種類のフレームのいずれかです。
  • リクエスト: { type: "req", id, method, params }
  • レスポンス: { type: "res", id, ok, payload | error }
  • イベント: { type: "event", event, payload, seq?, stateVersion? }
最初のフレームは 必ず connect リクエストでなければなりません。その後、クライアントはメソッド（例: health、send、chat.send）を呼び出し、イベント（例: presence、tick、agent）を購読できます。 接続フロー（最小）: 
Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|
一般的なメソッド + イベント:
カテゴリ例注記
コアconnect, health, statusconnect は最初でなければならない
メッセージングsend, agent, agent.wait, system-event, logs.tail副作用には idempotencyKey が必要
チャットchat.history, chat.send, chat.abortWebChat はこれらを使用
セッションsessions.list, sessions.patch, sessions.deleteセッション管理
自動化wake, cron.list, cron.run, cron.runswake + cron 制御
ノードnode.list, node.invoke, node.pair.*Gateway WS + ノードアクション
イベントtick, presence, agent, chat, health, shutdownサーバープッシュ
信頼できる、公開される ディスカバリー インベントリは src/gateway/server-methods-list.ts（listGatewayMethods、GATEWAY_EVENTS）にあります。

​
スキーマの場所

  • ソース: src/gateway/protocol/schema.ts
  • ランタイムバリデーター（AJV）: src/gateway/protocol/index.ts
  • 公開される機能/ディスカバリーレジストリ: src/gateway/server-methods-list.ts
  • サーバーハンドシェイク + メソッドディスパッチ: src/gateway/server.impl.ts
  • Node クライアント: src/gateway/client.ts
  • 生成された JSON Schema: dist/protocol.schema.json
  • 生成された Swift モデル: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​
現在のパイプライン

  • pnpm protocol:gen
    • JSON Schema（draft-07）を dist/protocol.schema.json に書き込みます
  • pnpm protocol:gen:swift
    • Swift Gateway モデルを生成します
  • pnpm protocol:check
    • 両方のジェネレーターを実行し、出力がコミットされていることを検証します

​
ランタイムでのスキーマの使われ方

  • サーバー側: すべての受信フレームは AJV で検証されます。ハンドシェイクは、params が ConnectParams に一致する connect リクエストのみを受け付けます。
  • クライアント側: JS クライアントは、イベントフレームとレスポンスフレームを使用する前に検証します。
  • 機能ディスカバリー: Gateway は listGatewayMethods() と GATEWAY_EVENTS から、保守的な features.methods と features.events のリストを hello-ok で送信します。
  • このディスカバリーリストは、coreGatewayHandlers 内のすべての呼び出し可能なヘルパーを生成ダンプしたものではありません。一部のヘルパー RPC は、公開される機能リストに列挙されずに src/gateway/server-methods/*.ts で実装されています。

​
フレーム例

Connect（最初のメッセージ）: 
{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 4,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}
Hello-ok レスポンス: 
{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 4,
    "server": { "version": "dev", "connId": "ws-1" },
    "features": { "methods": ["health"], "events": ["tick"] },
    "snapshot": {
      "presence": [],
      "health": {},
      "stateVersion": { "presence": 0, "health": 0 },
      "uptimeMs": 0
    },
    "policy": { "maxPayload": 1048576, "maxBufferedBytes": 1048576, "tickIntervalMs": 30000 }
  }
}
リクエスト + レスポンス: 
{ "type": "req", "id": "r1", "method": "health" }

{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }
イベント: 
{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

​
最小クライアント（Node.js）

最小の有用なフロー: connect + health。 
import { WebSocket } from "ws";

const ws = new WebSocket("ws://127.0.0.1:18789");

ws.on("open", () => {
  ws.send(
    JSON.stringify({
      type: "req",
      id: "c1",
      method: "connect",
      params: {
        minProtocol: 4,
        maxProtocol: 4,
        client: {
          id: "cli",
          displayName: "example",
          version: "dev",
          platform: "node",
          mode: "cli",
        },
      },
    }),
  );
});

ws.on("message", (data) => {
  const msg = JSON.parse(String(data));
  if (msg.type === "res" && msg.id === "c1" && msg.ok) {
    ws.send(JSON.stringify({ type: "req", id: "h1", method: "health" }));
  }
  if (msg.type === "res" && msg.id === "h1") {
    console.log("health:", msg.payload);
    ws.close();
  }
});

​
実例: メソッドをエンドツーエンドで追加する

例: { ok: true, text } を返す新しい system.echo リクエストを追加します。
  1. スキーマ（信頼できる情報源）
src/gateway/protocol/schema.ts に追加します。 
export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);
両方を ProtocolSchemas に追加し、型をエクスポートします。 
  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. 検証
src/gateway/protocol/index.ts で、AJV バリデーターをエクスポートします。 
export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);
  1. サーバーの動作
src/gateway/server-methods/system.ts にハンドラーを追加します。 
export const systemHandlers: GatewayRequestHandlers = {
  "system.echo": ({ params, respond }) => {
    const text = String(params.text ?? "");
    respond(true, { ok: true, text });
  },
};
src/gateway/server-methods.ts（すでに systemHandlers をマージしています）で登録し、 src/gateway/server-methods-list.ts の listGatewayMethods 入力に "system.echo" を追加します。 そのメソッドがオペレーターまたはノードクライアントから呼び出し可能な場合は、スコープ強制と hello-ok 機能広告を揃えるために、src/gateway/method-scopes.ts でも分類します。
  1. 再生成
pnpm protocol:check
  1. テスト + ドキュメント
src/gateway/server.*.test.ts にサーバーテストを追加し、ドキュメントにそのメソッドを記載します。

​
Swift コード生成の動作

Swift ジェネレーターは次を出力します。
  • req、res、event、unknown ケースを持つ GatewayFrame enum
  • 強く型付けされたペイロード struct/enum
  • ErrorCode 値、GATEWAY_PROTOCOL_VERSION、GATEWAY_MIN_PROTOCOL_VERSION
未知のフレームタイプは、前方互換性のために raw ペイロードとして保持されます。

​
バージョン管理 + 互換性

  • PROTOCOL_VERSION は src/gateway/protocol/version.ts にあります。
  • クライアントは minProtocol + maxProtocol を送信します。サーバーは、現在のプロトコルを含まない範囲を拒否します。
  • Swift モデルは、古いクライアントを壊さないように未知のフレームタイプを保持します。

​
スキーマパターンと規約

  • ほとんどのオブジェクトは、厳密なペイロードのために additionalProperties: false を使用します。
  • NonEmptyString は ID とメソッド/イベント名のデフォルトです。
  • トップレベルの GatewayFrame は type の discriminator を使用します。
  • 副作用のあるメソッドは通常、params に idempotencyKey を要求します（例: send、poll、agent、chat.send）。
  • agent は、ランタイム生成のオーケストレーションコンテキスト用に任意の internalEvents を受け付けます（例: サブエージェント/cron タスク完了の引き継ぎ）。これは内部 API サーフェスとして扱ってください。

​
ライブスキーマ JSON

生成された JSON Schema はリポジトリの dist/protocol.schema.json にあります。公開 raw ファイルは通常、次で利用できます。

​
スキーマを変更する場合

  1. TypeBox スキーマを更新します。
  2. src/gateway/server-methods-list.ts でメソッド/イベントを登録します。
  3. 新しい RPC にオペレーターまたはノードのスコープ分類が必要な場合は、src/gateway/method-scopes.ts を更新します。
  4. pnpm protocol:check を実行します。
  5. 再生成されたスキーマ + Swift モデルをコミットします。

​
関連