TypeBox

TypeBox as protocol source of truth

Last updated: 2026-01-10

TypeBox is a TypeScript-first schema library. We use it to define the Gateway WebSocket protocol (handshake, request/response, server events). Those schemas drive runtime validation, JSON Schema export, and Swift codegen for the macOS app. One source of truth; everything else is generated.

If you want the higher-level protocol context, start with Gateway architecture.

Mental model (30 seconds)

Every Gateway WS message is one of three frames:

• Request:
  text

  Copy

  { type: "req", id, method, params }
• Response:
  text

  Copy

  { type: "res", id, ok, payload | error }
• Event:
  text

  Copy

  { type: "event", event, payload, seq?, stateVersion? }

The first frame must be a

request. After that, clients can call methods (e.g. , , ) and subscribe to events (e.g. , , ).

Connection flow (minimal):

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

Common methods + events:

Authoritative advertised discovery inventory lives in

(, ).

Where the schemas live

• Source:
  text

  Copy

  src/gateway/protocol/schema.ts
• Runtime validators (AJV):
  text

  Copy

  src/gateway/protocol/index.ts
• Advertised feature/discovery registry:
  text

  Copy

  src/gateway/server-methods-list.ts
• Server handshake + method dispatch:
  text

  Copy

  src/gateway/server.impl.ts
• Node client:
  text

  Copy

  src/gateway/client.ts
• Generated JSON Schema:
  text

  Copy

  dist/protocol.schema.json
• Generated Swift models:
  text

  Copy

  apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

Current pipeline

• text

  Copy

  pnpm protocol:gen
  • writes JSON Schema (draft‑07) to
    text

    Copy

    dist/protocol.schema.json
• text

  Copy

  pnpm protocol:gen:swift
  • generates Swift gateway models
• text

  Copy

  pnpm protocol:check
  • runs both generators and verifies the output is committed

How the schemas are used at runtime

• Server side: every inbound frame is validated with AJV. The handshake only accepts a
  text

  Copy

  connect
  request whose params match
  text

  Copy

  ConnectParams
  .
• Client side: the JS client validates event and response frames before using them.
• Feature discovery: the Gateway sends a conservative
  text

  Copy

  features.methods
  and
  text

  Copy

  features.events
  list in
  text

  Copy

  hello-ok
  from
  text

  Copy

  listGatewayMethods()
  and
  text

  Copy

  GATEWAY_EVENTS
  .
• That discovery list is not a generated dump of every callable helper in
  text

  Copy

  coreGatewayHandlers
  ; some helper RPCs are implemented in
  text

  Copy

  src/gateway/server-methods/*.ts
  without being enumerated in the advertised feature list.

Example frames

Connect (first message):

json
Copy
{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 3,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}

Hello-ok response:

json
Copy
{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 3,
    "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 }
  }
}

Request + response:

json
Copy
{ "type": "req", "id": "r1", "method": "health" }

json
Copy
{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }

Event:

json
Copy
{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

Minimal client (Node.js)

Smallest useful flow: connect + health.

ts
Copy
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();
  }
});

Worked example: add a method end-to-end

Example: add a new

request that returns .

1. Schema (source of truth)

Add to

:

ts
Copy
export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);

Add both to

and export types:

ts
Copy
  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

ts
Copy
export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;

2. Validation

In

, export an AJV validator:

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

3. Server behavior

Add a handler in

:

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

Register it in

(already merges ), then add to input in .

If the method is callable by operator or node clients, also classify it in

so scope enforcement and feature advertising stay aligned.

4. Regenerate

bash
Copy
pnpm protocol:check

5. Tests + docs

Add a server test in

and note the method in docs.

Swift codegen behavior

The Swift generator emits:

• text

  Copy

  GatewayFrame
  enum with
  text

  Copy

  req
  ,
  text

  Copy

  res
  ,
  text

  Copy

  event
  , and
  text

  Copy

  unknown
  cases
• Strongly typed payload structs/enums
• text

  Copy

  ErrorCode
  values and
  text

  Copy

  GATEWAY_PROTOCOL_VERSION

Unknown frame types are preserved as raw payloads for forward compatibility.

Versioning + compatibility

• text

  Copy

  PROTOCOL_VERSION
  lives in
  text

  Copy

  src/gateway/protocol/schema.ts
  .
• Clients send
  text

  Copy

  minProtocol
  +
  text

  Copy

  maxProtocol
  ; the server rejects mismatches.
• The Swift models keep unknown frame types to avoid breaking older clients.

Schema patterns and conventions

• Most objects use
  text

  Copy

  additionalProperties: false
  for strict payloads.
• text

  Copy

  NonEmptyString
  is the default for IDs and method/event names.
• The top-level
  text

  Copy

  GatewayFrame
  uses a discriminator on
  text

  Copy

  type
  .
• Methods with side effects usually require an
  text

  Copy

  idempotencyKey
  in params (example:
  text

  Copy

  send
  ,
  text

  Copy

  poll
  ,
  text

  Copy

  agent
  ,
  text

  Copy

  chat.send
  ).
• text

  Copy

  agent
  accepts optional
  text

  Copy

  internalEvents
  for runtime-generated orchestration context (for example subagent/cron task completion handoff); treat this as internal API surface.

Live schema JSON

Generated JSON Schema is in the repo at

. The published raw file is typically available at:

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

When you change schemas

1. Update the TypeBox schemas.
2. Register the method/event in
   text

   Copy

   src/gateway/server-methods-list.ts
   .
3. Update
   text

   Copy

   src/gateway/method-scopes.ts
   when the new RPC needs operator or node scope classification.
4. Run
   text

   Copy

   pnpm protocol:check
   .
5. Commit the regenerated schema + Swift models.

Related

• Rich output protocol
• RPC adapters