メインコンテンツへスキップ
TypeBoxはTypeScriptファーストのスキーマライブラリです。OpenClawはこれを使ってGateway WebSocketプロトコル（ハンドシェイク、リクエスト/レスポンス、サーバーイベント）を定義しています。これらのスキーマは、ランタイム検証（AJV）、JSON Schemaエクスポート、macOSアプリ向けのSwiftコード生成を駆動します。単一の信頼できる情報源があり、それ以外はすべて生成されます。 より高レベルのプロトコルコンテキストについては、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）にあります。

​
スキーマの場所

  • ソースbarrel: packages/gateway-protocol/src/schema.tsは、packages/gateway-protocol/src/schema/*.ts配下のドメインモジュールを再エクスポートします（トップレベルのエンベロープとハンドシェイク用のframes.ts、機能領域ごとのagent.ts, sessions.ts, cron.tsなど）。protocol-schemas.tsは、スキーマ名をTypeBox定義にマッピングする中心的なProtocolSchemasレジストリです。
  • ランタイムバリデーター（AJV）: packages/gateway-protocol/src/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/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​
現在のパイプライン

  • pnpm protocol:genはJSON Schema（draft-07）をdist/protocol.schema.jsonへ書き込みます。
  • pnpm protocol:gen:swiftはSwift gatewayモデルを生成します。
  • pnpm protocol:checkは両方のジェネレーターを実行し、Swift出力がコミットされていることを検証します（JSON Schema出力はgitignoreされたビルドアーティファクトです）。

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

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

​
フレーム例

接続（最初のメッセージ）: 
{
  "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
    },
    "auth": { "role": "operator", "scopes": ["operator.read"] },
    "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）

最小限の有用なフロー: 接続 + 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. スキーマ（信頼できる情報源）
packages/gateway-protocol/src/schema/system.ts（または最も近い機能モジュール）に追加します。 
export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);
両方をpackages/gateway-protocol/src/schema/protocol-schemas.tsにインポートし、ProtocolSchemasレジストリへ追加して、派生型をエクスポートします。 
  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. 検証
packages/gateway-protocol/src/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"を追加します。 そのメソッドがoperatorまたはノードクライアントから呼び出し可能な場合は、スコープ適用と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
  • 強く型付けされたpayloadのstruct/enum
  • ErrorCode値、GATEWAY_PROTOCOL_VERSION、GATEWAY_MIN_PROTOCOL_VERSION
未知のフレームタイプは、前方互換性のためにraw payloadとして保持されます。

​
バージョニングと互換性

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

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

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

​
ライブスキーマJSON

生成されたJSON Schemaはビルドアーティファクトであり、リポジトリにはコミットされません。公開されるrawファイルは通常、次の場所で利用できます。

​
スキーマを変更するとき

  1. 所有するpackages/gateway-protocol/src/schema/*.tsモジュールのTypeBoxスキーマを更新し、protocol-schemas.tsに登録します。
  2. src/gateway/server-methods-list.tsにメソッド/イベントを登録します。
  3. 新しいRPCがoperatorまたはノードスコープ分類を必要とする場合は、src/gateway/method-scopes.tsを更新します。
  4. pnpm protocol:checkを実行します。
  5. 再生成されたSwiftモデルをコミットします。

​
関連