TypeBox

TypeBox 是以 TypeScript 為優先的結構描述函式庫。我們用它來定義 閘道 WebSocket 協定（握手、請求/回應、伺服器事件）。這些結構描述會驅動 執行階段驗證、JSON Schema 匯出，以及 macOS app 的 Swift 程式碼產生。 單一真實來源；其他一切都由它產生。

如果你想了解較高層次的協定脈絡，請從 閘道架構開始。

心智模型（30 秒）

每個閘道 WS 訊息都是三種框架之一：

• 請求：{ 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 ----------|

常用方法 + 事件：

權威的已宣告 探索 清單位於 src/gateway/server-methods-list.ts（listGatewayMethods、GATEWAY_EVENTS）。

結構描述的位置

• 來源：packages/gateway-protocol/src/schema.ts
• 執行階段驗證器（AJV）：packages/gateway-protocol/src/index.ts
• 已宣告功能/探索登錄：src/gateway/server-methods-list.ts
• 伺服器握手 + 方法分派：src/gateway/server.impl.ts
• 節點用戶端：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 閘道模型
• pnpm protocol:check
  • 執行兩個產生器並驗證輸出已提交

結構描述在執行階段的使用方式

• 伺服器端：每個傳入框架都會用 AJV 驗證。握手只接受 params 符合 ConnectParams 的 connect 請求。
• 用戶端：JS 用戶端會在使用事件與回應框架前先驗證它們。
• 功能探索：閘道會在 hello-ok 中，從 listGatewayMethods() 與 GATEWAY_EVENTS 傳送保守的 features.methods 與 features.events 清單。
• 該探索清單不是 coreGatewayHandlers 中每個可呼叫 helper 的產生式傾印； 有些 helper 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。

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

2. 驗證

在 packages/gateway-protocol/src/index.ts 中，匯出 AJV 驗證器：

export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);

3. 伺服器行為

在 src/gateway/server-methods/system.ts 中新增 handler：

export const systemHandlers: GatewayRequestHandlers = {  "system.echo": ({ params, respond }) => {    const text = String(params.text ?? "");    respond(true, { ok: true, text });  },};

在 src/gateway/server-methods.ts 中註冊它（已經合併 systemHandlers）， 然後將 "system.echo" 加到 src/gateway/server-methods-list.ts 中的 listGatewayMethods 輸入。

如果該方法可由 operator 或節點用戶端呼叫，也請在 src/gateway/method-scopes.ts 中分類它，讓範圍強制執行與 hello-ok 功能宣告保持一致。

4. 重新產生

pnpm protocol:check

5. 測試 + 文件

在 src/gateway/server.*.test.ts 中新增伺服器測試，並在文件中記錄該方法。

Swift 程式碼產生行為

Swift 產生器會輸出：

• 含有 req、res、event 與 unknown case 的 GatewayFrame enum
• 強型別 payload structs/enums
• ErrorCode 值、GATEWAY_PROTOCOL_VERSION 與 GATEWAY_MIN_PROTOCOL_VERSION

未知框架型別會保留為原始 payload，以提供向前相容性。

版本控管 + 相容性

• PROTOCOL_VERSION 位於 packages/gateway-protocol/src/version.ts。
• 用戶端會傳送 minProtocol + maxProtocol；伺服器會拒絕不包含其目前協定的範圍。
• Swift 模型會保留未知框架型別，以避免破壞較舊用戶端。

結構描述模式與慣例

• 多數物件使用 additionalProperties: false 來提供嚴格 payload。
• NonEmptyString 是 ID 與方法/事件名稱的預設值。
• 最上層 GatewayFrame 會在 type 上使用 discriminator。
• 有副作用的方法通常要求 params 中有 idempotencyKey （範例：send、poll、agent、chat.send）。
• agent 接受選用的 internalEvents，供執行階段產生的協調脈絡使用 （例如 subagent/cron 任務完成交接）；請將此視為內部 API 介面。

即時結構描述 JSON

產生的 JSON Schema 位於 repo 的 dist/protocol.schema.json。已發布的原始檔通常可於：

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

變更結構描述時

1. 更新 TypeBox 結構描述。
2. 在 src/gateway/server-methods-list.ts 中註冊方法/事件。
3. 當新的 RPC 需要 operator 或節點範圍分類時，更新 src/gateway/method-scopes.ts。
4. 執行 pnpm protocol:check。
5. 提交重新產生的結構描述 + Swift 模型。

相關

• 豐富輸出協定
• RPC 轉接器