Skip to main content

​
TypeBox 作为协议的唯一真实来源

最后更新：2026-01-10 TypeBox 是一个以 TypeScript 为优先的模式库。我们用它来定义 网关 WebSocket 协议（握手、请求/响应、服务器事件）。这些模式驱动着 运行时验证、JSON Schema 导出，以及 macOS 应用的 Swift 代码生成。唯一真实来源；其余一切均为生成。 如果你想了解更高层次的协议上下文，可以从 网关架构 开始。

​
理解模型（30 秒）

每个网关 WS 消息都是三种帧之一：
  • 请求（Request）：{ type: "req", id, method, params }
  • 响应（Response）：{ type: "res", id, ok, payload | error }
  • 事件（Event）：{ type: "event", event, payload, seq?, stateVersion? }
第一个帧 必须 是 connect 请求。之后，客户端可以调用方法（如 health、send、chat.send）并订阅事件（如 presence、tick、agent）。 连接流程（最简示例）： 
客户端                    网关
  |---- 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.*网关 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 客户端在使用事件和响应帧前进行验证。
  • 方法接口：网关在 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"
    }
  }
}
Hello-ok 响应： 
{
  "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）

最简有用流程：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: 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），然后在 src/gateway/server.ts 的 METHODS 中添加 "system.echo"。
  1. 重新生成
pnpm protocol:check
  1. 测试 + 文档
在 src/gateway/server.*.test.ts 添加服务器测试，并在文档中标注该方法。

​
Swift 代码生成行为

Swift 生成器输出：
  • GatewayFrame 枚举，包含 req、res、event 和 unknown 分支
  • 强类型的负载结构体/枚举
  • ErrorCode 值和 GATEWAY_PROTOCOL_VERSION
未知的帧类型会作为原始负载保留，以保证向前兼容。

​
版本和兼容性

  • PROTOCOL_VERSION 位于 src/gateway/protocol/schema.ts。
  • 客户端发送 minProtocol 和 maxProtocol；服务器拒绝不匹配。
  • Swift 模型保留未知帧类型以免破坏旧客户端。

​
模式规范和约定

  • 大多数对象使用 additionalProperties: false，确保负载严格。
  • ID 和方法/事件名默认使用 NonEmptyString。
  • 顶层 GatewayFrame 在 type 字段上使用 区分符。
  • 有副作用的方法通常要求参数中包含 idempotencyKey （例如：send、poll、agent、chat.send）。
  • agent 接受可选的 internalEvents 用于运行时生成的编排上下文 （如子代理/计划任务完成交接）；视为内部 API。

​
线上模式 JSON

生成的 JSON Schema 在仓库路径 dist/protocol.schema.json。发布的原始文件通常可访问：

​
修改模式时

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