Concept internals

TypeBox

TypeBox は TypeScript ファーストのスキーマライブラリです。これは Gateway WebSocket プロトコル（ハンドシェイク、リクエスト/レスポンス、サーバーイベント）を定義するために使います。これらのスキーマが ランタイム検証、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`, `status`	`connect` は最初でなければならない
メッセージング	`send`, `agent`, `agent.wait`, `system-event`, `logs.tail`	副作用には `idempotencyKey` が必要
チャット	`chat.history`, `chat.send`, `chat.abort`	WebChat はこれらを使用
セッション	`sessions.list`, `sessions.patch`, `sessions.delete`	セッション管理
自動化	`wake`, `cron.list`, `cron.run`, `cron.runs`	wake + cron 制御
ノード	`node.list`, `node.invoke`, `node.pair.*`	Gateway WS + ノードアクション
イベント	`tick`, `presence`, `agent`, `chat`, `health`, `shutdown`	サーバープッシュ

正式に公開される discovery インベントリは src/gateway/server-methods-list.ts（listGatewayMethods, GATEWAY_EVENTS）にあります。

スキーマの場所

ソース: src/gateway/protocol/schema.ts
ランタイムバリデータ（AJV）: src/gateway/protocol/index.ts
公開される機能/discovery レジストリ: 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 クライアントは、イベントフレームとレスポンスフレームを使用する前に検証します。
機能 discovery: Gateway は hello-ok 内で、listGatewayMethods() と GATEWAY_EVENTS から得た保守的な features.methods と features.events のリストを送信します。
この discovery リストは、coreGatewayHandlers 内の呼び出し可能なヘルパーすべてを生成してダンプしたものではありません。一部のヘルパー RPC は、公開される機能リストに列挙されないまま src/gateway/server-methods/*.ts に実装されています。

フレーム例

Connect（最初のメッセージ）:

{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 4,
    "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。


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 リクエストを追加します。

スキーマ（信頼できる唯一の情報源）

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>;

検証

src/gateway/protocol/index.ts で、AJV バリデータをエクスポートします。

export const validateSystemEchoParams = ajv.compile&lt;SystemEchoParams&gt;(SystemEchoParamsSchema);

サーバー動作

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 でも分類してください。

再生成

pnpm protocol:check

テスト + ドキュメント

src/gateway/server.*.test.ts にサーバーテストを追加し、ドキュメントにそのメソッドを記載します。

Swift コード生成の動作

Swift ジェネレータは次を出力します。

req, res, event, unknown ケースを持つ GatewayFrame enum
厳密に型付けされたペイロード struct/enum
ErrorCode 値と GATEWAY_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 surface として扱ってください。

ライブスキーマ JSON

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

https://raw.githubusercontent.com/openclaw/openclaw/main/dist/protocol.schema.json

スキーマを変更するとき

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

TypeBox

メンタルモデル（30 秒）

スキーマの場所

現在のパイプライン

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

フレーム例

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

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

Swift コード生成の動作

バージョニング + 互換性

スキーマパターンと規約

ライブスキーマ JSON

スキーマを変更するとき

関連

Ask OpenClaw

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

# スキーマの場所

# 現在のパイプライン

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

# フレーム例

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

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

# Swift コード生成の動作

# バージョニング + 互換性

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

# ライブスキーマ JSON

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

# 関連

メンタルモデル（30 秒）

スキーマの場所

現在のパイプライン

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

フレーム例

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

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

Swift コード生成の動作

バージョニング + 互換性

スキーマパターンと規約

ライブスキーマ JSON

スキーマを変更するとき

関連