TypeBox

TypeBox 作为协议事实来源

最后更新：2026-01-10

TypeBox 是一个 TypeScript 优先的模式库。我们用它来定义 Gateway WebSocket 协议（握手、请求/响应、服务器事件）。这些模式驱动运行时验证、JSON Schema 导出和 macOS 应用的 Swift 代码生成。一个事实来源；其他都是生成的。

如果你想要更高级的协议上下文，从 Gateway architecture 开始。

心理模型（30 秒）

每个 Gateway 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）。

连接流（最小）：

Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|

常见方法 + 事件：

类别	示例	注意
Core	`connect`, `health`, `status`	`connect` 必须是第一个
Messaging	`send`, `poll`, `agent`, `agent.wait`	副作用需要 `idempotencyKey`
Chat	`chat.history`, `chat.send`, `chat.abort`, `chat.inject`	WebChat 使用这些
Sessions	`sessions.list`, `sessions.patch`, `sessions.delete`	会话管理
Nodes	`node.list`, `node.invoke`, `node.pair.*`	Gateway WS + node 动作
Events	`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
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 验证。握手只接受参数匹配 ConnectParams 的 connect 请求。
客户端：JS 客户端在使用之前验证事件和响应帧。
方法表面：Gateway 在 hello-ok 中通告支持的 methods 和 events。

示例帧

Connect（第一条消息）：

{
  "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 }。

模式（事实来源）

添加到 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<SystemEchoParams>(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），然后将 "system.echo" 添加到 src/gateway/server.ts 中的 METHODS。

重新生成

pnpm protocol:check

测试 + 文档

在 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 进行严格负载。
NonEmptyString 是 ID 和方法/事件名称的默认值。
顶级 GatewayFrame 在 type 上使用判别器。
有副作用的方法通常在参数中需要 idempotencyKey（示例：send、poll、agent、chat.send）。
agent 接受可选的 internalEvents 用于运行时生成的编排上下文（例如子 agent/cron 任务完成交接）；将此视为内部 API 表面。

实时模式 JSON

生成的 JSON Schema 在 repo 的 dist/protocol.schema.json。发布的原始文件通常可在以下位置获得：

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

当你更改模式时

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