TypeBox als zentrale Protokoll-Quelle

Zuletzt aktualisiert: 10.01.2026

TypeBox ist eine TypeScript-first Schema-Bibliothek. Wir nutzen sie, um das Gateway WebSocket-Protokoll zu definieren (Handshake, Request/Response, Server-Events). Diese Schemas treiben die Runtime-Validierung, den JSON Schema Export und die Swift-Codegen für die macOS-App an. Eine zentrale Quelle — alles andere wird generiert.

Wenn du den übergeordneten Protokoll-Kontext verstehen willst, starte mit der Gateway-Architektur.

Mentales Modell (30 Sekunden)

Jede Gateway-WS-Nachricht ist einer von drei Frame-Typen:

Request: { type: "req", id, method, params }
Response: { type: "res", id, ok, payload | error }
Event: { type: "event", event, payload, seq?, stateVersion? }

Der erste Frame muss ein connect-Request sein. Danach können Clients Methoden aufrufen (z.B. health, send, chat.send) und Events abonnieren (z.B. presence, tick, agent).

Verbindungsablauf (minimal):

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

Gängige Methoden + Events:

Kategorie	Beispiele	Hinweise
Core	`connect`, `health`, `status`	`connect` muss zuerst kommen
Messaging	`send`, `poll`, `agent`, `agent.wait`	Side-Effects brauchen `idempotencyKey`
Chat	`chat.history`, `chat.send`, `chat.abort`, `chat.inject`	WebChat nutzt diese
Sessions	`sessions.list`, `sessions.patch`, `sessions.delete`	Session-Verwaltung
Nodes	`node.list`, `node.invoke`, `node.pair.*`	Gateway WS + Node-Aktionen
Events	`tick`, `presence`, `agent`, `chat`, `health`, `shutdown`	Server-Push

Die autoritative Liste findest du in src/gateway/server.ts (METHODS, EVENTS).

Wo die Schemas liegen

Quelle: src/gateway/protocol/schema.ts
Runtime-Validatoren (AJV): src/gateway/protocol/index.ts
Server-Handshake + Method-Dispatch: src/gateway/server.ts
Node-Client: src/gateway/client.ts
Generiertes JSON Schema: dist/protocol.schema.json
Generierte Swift-Models: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

Aktuelle Pipeline

pnpm protocol:gen
- schreibt JSON Schema (draft-07) nach dist/protocol.schema.json
pnpm protocol:gen:swift
- generiert Swift Gateway-Models
pnpm protocol:check
- führt beide Generatoren aus und prüft, ob der Output committet ist

Wie die Schemas zur Runtime genutzt werden

Server-Seite: Jeder eingehende Frame wird mit AJV validiert. Der Handshake akzeptiert nur einen connect-Request, dessen Params zu ConnectParams passen.
Client-Seite: Der JS-Client validiert Event- und Response-Frames, bevor er sie verwendet.
Method-Surface: Das Gateway gibt die unterstützten methods und events in hello-ok bekannt.

Beispiel-Frames

Connect (erste Nachricht):

{
  "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 Response:

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

Request + Response:

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

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

Event:

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

Minimaler Client (Node.js)

Der kleinste sinnvolle Ablauf: 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();
  }
});

Praxisbeispiel: Eine Methode End-to-End hinzufuegen

Beispiel: Einen neuen system.echo-Request hinzufuegen, der { ok: true, text } zurueckgibt.

Schema (zentrale Quelle)

Fuege in src/gateway/protocol/schema.ts hinzu:

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

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

Fuege beides zu ProtocolSchemas hinzu und exportiere die Typen:

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

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

Validierung

In src/gateway/protocol/index.ts exportiere einen AJV-Validator:

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

Server-Verhalten

Fuege einen Handler in src/gateway/server-methods/system.ts hinzu:

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

Registriere ihn in src/gateway/server-methods.ts (merged bereits systemHandlers), dann fuege "system.echo" zu METHODS in src/gateway/server.ts hinzu.

Neu generieren

pnpm protocol:check

Tests + Docs

Fuege einen Server-Test in src/gateway/server.*.test.ts hinzu und dokumentiere die Methode.

Swift-Codegen-Verhalten

Der Swift-Generator erzeugt:

GatewayFrame Enum mit req, res, event und unknown Cases
Stark typisierte Payload-Structs/Enums
ErrorCode-Werte und GATEWAY_PROTOCOL_VERSION

Unbekannte Frame-Typen werden als Raw-Payloads beibehalten, um Vorwaertskompatibilitaet zu gewaehrleisten.

Versionierung + Kompatibilitaet

PROTOCOL_VERSION liegt in src/gateway/protocol/schema.ts.
Clients senden minProtocol + maxProtocol; der Server lehnt Mismatches ab.
Die Swift-Models behalten unbekannte Frame-Typen bei, um aeltere Clients nicht zu brechen.

Schema-Patterns und Konventionen

Die meisten Objekte nutzen additionalProperties: false fuer strikte Payloads.
NonEmptyString ist der Standard fuer IDs und Method-/Event-Namen.
Der Top-Level GatewayFrame nutzt einen Discriminator auf type.
Methoden mit Side-Effects erfordern normalerweise einen idempotencyKey in den Params (Beispiel: send, poll, agent, chat.send).

Live Schema JSON

Das generierte JSON Schema liegt im Repo unter dist/protocol.schema.json. Die veroeffentlichte Raw-Datei ist normalerweise hier verfuegbar:

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

Wenn du Schemas aenderst

Aktualisiere die TypeBox-Schemas.
Fuehre pnpm protocol:check aus.
Committe das neu generierte Schema + die Swift-Models.