Skip to main content
__HEADING_0__TypeBox作为协议事实来源 最后更新：2026-01-10 TypeBox 是一个以 TypeScript 为先的模式库。我们用它来定义 Gateway WebSocket 协议——包括握手、请求/响应以及服务器事件。这些模式驱动着运行时验证、JSON Schema 导出，以及用于 macOS 应用的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 ----------|
常见方法与事件：
类别示例备注
核心connect、health、statusconnect 必须是第一个
消息传递send、poll、agent、agent.wait副作用需要 idempotencyKey
聊天chat.history、chat.send、chat.abort、chat.injectWebChat 使用这些
会话sessions.list、sessions.patch、sessions.delete会话管理员
节点node.list、node.invoke、node.pair.*Gateway WS + 节诺操作
事件tick、presence、agent、chat、health、shutdown服务器推送
权威列表位于 src/gateway/server.ts（METHODS、EVENTS）。

​
模式所在位置

  • 源代码：src/gateway/protocol/schema.ts
  • 运行时验证器（AJV）：src/gateway/protocol/index.ts
  • 服务器握手 + 方法分派：src/gateway/server.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 进行验证。握手仅接受参数匹配 ConnectParams 的 connect 请求。
  • 客户端端：JS 客户端在使用事件和响应帧之前对其进行验证。
  • 方法表面：Gateway 在 hello-ok 中公布支持的 methods 和 events。

​
示例帧

连接（第一条消息）： 
{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 2,
    "maxProtocol": 2,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}
“你好”确认响应： 
{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 2,
    "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）

最小有用流程：连接 + 健康检查。 
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: 3,
      maxProtocol: 3,
      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();
  }
});

​
示例演练：端到端添加一个方法

示例：添加一个新的 system.echo 请求，该请求返回 { ok: true, text }。
  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），然后将 "system.echo" 添加到 METHODS 中的 src/gateway/server.ts。
  1. 重新生成
pnpm protocol:check
  1. 测试 + 文档
在 src/gateway/server.*.test.ts 中添加一个服务器测试，并在文档中记录该方法。 __HEADING_0__Swift 代码生成行为 Swift 生成器会发出：
  • 包含 GatewayFrame、req、res 和 event 案例的 unknown 枚举
  • 强类型负载结构体/枚举
  • ErrorCode 值和 GATEWAY_PROTOCOL_VERSION
未知帧类型将作为原始负载保留，以确保向前兼容性。

​
版本控制 + 兼容性

  • PROTOCOL_VERSION 存在于 src/gateway/protocol/schema.ts 中。
  • 客户端发送 minProtocol + maxProtocol；服务器会拒绝不匹配的请求。
  • Swift 模型会保留未知帧类型，以避免破坏旧客户端。

​
模式与约定

  • 大多数对象使用 additionalProperties: false 来实现严格负载。
  • NonEmptyString 是 ID 和方法/事件名称的默认值。
  • 顶级 GatewayFrame 在 type 上使用判别符。
  • 具有副作用的方法通常要求参数中包含 idempotencyKey（例如：send、poll、agent、chat.send）。

​
实时模式 JSON

生成的 JSON Schema 位于仓库中的 dist/protocol.schema.json。发布的原始文件通常可在以下地址获取：

​
更改模式时的操作步骤

  1. 更新 TypeBox 模式。
  2. 运行 pnpm protocol:check。
  3. 提交重新生成的模式 + Swift 模型。