​

TypeBox als Single Source of Truth für das Protokoll

​

Mentales Modell (30 Sekunden)

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

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

​

Wo die Schemas liegen

• Quelle: src/gateway/protocol/schema.ts
• Laufzeitvalidatoren (AJV): src/gateway/protocol/index.ts
• Beworbene Feature-/Discovery-Registry: src/gateway/server-methods-list.ts
• Server-Handshake + Methodendispatch: src/gateway/server.impl.ts
• Knoten-Client: src/gateway/client.ts
• Generiertes JSON-Schema: dist/protocol.schema.json
• Generierte Swift-Modelle: 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-Modelle
• pnpm protocol:check
  • führt beide Generatoren aus und prüft, ob die Ausgabe eingecheckt ist

​

Wie die Schemas zur Laufzeit verwendet werden

• Serverseitig: Jeder eingehende Frame wird mit AJV validiert. Der Handshake akzeptiert nur eine connect-Anfrage, deren Parameter zu ConnectParams passen.
• Clientseitig: Der JS-Client validiert Ereignis- und Antwort-Frames, bevor er sie verwendet.
• Feature-Discovery: Das Gateway sendet ein konservatives features.methods und eine features.events-Liste in hello-ok aus listGatewayMethods() und GATEWAY_EVENTS.
• Diese Discovery-Liste ist kein generierter Dump jedes aufrufbaren Hilfsprogramms in coreGatewayHandlers; einige Hilfs-RPCs werden in src/gateway/server-methods/*.ts implementiert, ohne in der beworbenen Feature-Liste aufgezählt zu sein.

​

Beispiel-Frames

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

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

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

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

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

​

Minimaler Client (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();
  }
});

​

Durchgearbeitetes Beispiel: eine Methode Ende-zu-Ende hinzufügen

1. Schema (Single Source of Truth)

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

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

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

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

2. Validierung

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

3. Serververhalten

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

4. Neu generieren

pnpm protocol:check

5. Tests + Dokumentation

​

Verhalten des Swift-Codegens

• GatewayFrame-Enum mit Fällen req, res, event und unknown
• Stark typisierte Payload-Structs/-Enums
• ErrorCode-Werte und GATEWAY_PROTOCOL_VERSION

​

Versionierung + Kompatibilität

• PROTOCOL_VERSION befindet sich in src/gateway/protocol/schema.ts.
• Clients senden minProtocol + maxProtocol; der Server lehnt Nichtübereinstimmungen ab.
• Die Swift-Modelle behalten unbekannte Frame-Typen bei, damit ältere Clients nicht brechen.

​

Schema-Muster und Konventionen

• Die meisten Objekte verwenden additionalProperties: false für strikte Payloads.
• NonEmptyString ist der Standard für IDs und Methoden-/Ereignisnamen.
• Das Top-Level-GatewayFrame verwendet einen Discriminator auf type.
• Methoden mit Nebeneffekten erfordern in den Parametern normalerweise einen idempotencyKey (Beispiel: send, poll, agent, chat.send).
• agent akzeptiert optionale internalEvents für runtime-generierten Orchestrierungskontext (zum Beispiel Übergabe bei Abschluss von Subagent-/Cron-Aufgaben); behandeln Sie dies als interne API-Oberfläche.

​

Live-Schema-JSON

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

​

Wenn Sie Schemas ändern

1. Die TypeBox-Schemas aktualisieren.
2. Die Methode/das Ereignis in src/gateway/server-methods-list.ts registrieren.
3. src/gateway/method-scopes.ts aktualisieren, wenn das neue RPC eine Scope-Klassifizierung für Operator oder Knoten benötigt.
4. pnpm protocol:check ausführen.
5. Das neu generierte Schema + die Swift-Modelle committen.