Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

TypeBox ist eine TypeScript-first Schema-Bibliothek. Wir verwenden sie, um das Gateway WebSocket-Protokoll zu definieren (Handshake, Request/Response, Serverereignisse). Diese Schemas steuern Runtime-Validierung, JSON-Schema-Export und Swift-Codegenerierung für die macOS-App. Eine einzige Quelle der Wahrheit; alles andere wird generiert. Wenn Sie den übergeordneten Protokollkontext benötigen, beginnen Sie mit Gateway-Architektur.

​
Mentales Modell (30 Sekunden)

Jede Gateway-WS-Nachricht ist einer von drei Frames:
  • Request: { type: "req", id, method, params }
  • Response: { type: "res", id, ok, payload | error }
  • Ereignis: { 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 Ereignisse abonnieren (z. B. presence, tick, agent). Verbindungsablauf (minimal): 
Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|
Gängige Methoden + Ereignisse:
KategorieBeispieleHinweise
Kernconnect, health, statusconnect muss zuerst kommen
Messagingsend, agent, agent.wait, system-event, logs.tailNebeneffekte benötigen idempotencyKey
Chatchat.history, chat.send, chat.abortWebChat verwendet diese
Sitzungensessions.list, sessions.patch, sessions.deleteSitzungsadministration
Automatisierungwake, cron.list, cron.run, cron.runsWake- + Cron-Steuerung
Nodesnode.list, node.invoke, node.pair.*Gateway-WS + Node-Aktionen
Ereignissetick, presence, agent, chat, health, shutdownServer-Push
Das verbindliche beworbene Discovery-Inventar befindet sich in src/gateway/server-methods-list.ts (listGatewayMethods, GATEWAY_EVENTS).

​
Wo die Schemas liegen

  • Quelle: src/gateway/protocol/schema.ts
  • Runtime-Validatoren (AJV): src/gateway/protocol/index.ts
  • Beworbene Feature-/Discovery-Registry: src/gateway/server-methods-list.ts
  • Server-Handshake + Methoden-Dispatch: src/gateway/server.impl.ts
  • Node-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 committet ist

​
Wie die Schemas zur Laufzeit verwendet werden

  • Serverseitig: Jeder eingehende Frame wird mit AJV validiert. Der Handshake akzeptiert nur einen connect-Request, dessen Parameter ConnectParams entsprechen.
  • Clientseitig: Der JS-Client validiert Ereignis- und Response-Frames, bevor er sie verwendet.
  • Feature-Discovery: Das Gateway sendet eine konservative Liste features.methods und features.events in hello-ok aus listGatewayMethods() und GATEWAY_EVENTS.
  • Diese Discovery-Liste ist kein generierter Dump jedes aufrufbaren Helpers in coreGatewayHandlers; einige Helper-RPCs sind in src/gateway/server-methods/*.ts implementiert, ohne in der beworbenen Feature-Liste aufgeführt zu sein.

​
Beispiel-Frames

Connect (erste Nachricht): 
{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 4,
    "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": 4,
    "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 } }
Ereignis: 
{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

​
Minimaler Client (Node.js)

Kleinster sinnvoller Ablauf: verbinden + Health-Prüfung. 
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: 4,
        maxProtocol: 4,
        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

Beispiel: Fügen Sie ein neues system.echo-Request hinzu, das { ok: true, text } zurückgibt.
  1. Schema (Quelle der Wahrheit)
Zu src/gateway/protocol/schema.ts hinzufügen: 
export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);
Beide zu ProtocolSchemas hinzufügen und Typen exportieren: 
  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. Validierung
In src/gateway/protocol/index.ts einen AJV-Validator exportieren: 
export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);
  1. Serververhalten
Einen Handler in src/gateway/server-methods/system.ts hinzufügen: 
export const systemHandlers: GatewayRequestHandlers = {
  "system.echo": ({ params, respond }) => {
    const text = String(params.text ?? "");
    respond(true, { ok: true, text });
  },
};
Registrieren Sie ihn in src/gateway/server-methods.ts (führt systemHandlers bereits zusammen), und fügen Sie dann "system.echo" zur Eingabe von listGatewayMethods in src/gateway/server-methods-list.ts hinzu. Wenn die Methode von Operator- oder Node-Clients aufrufbar ist, klassifizieren Sie sie außerdem in src/gateway/method-scopes.ts, damit Scope-Durchsetzung und hello-ok-Feature- Anzeige abgestimmt bleiben.
  1. Neu generieren
pnpm protocol:check
  1. Tests + Dokumentation
Fügen Sie einen Servertest in src/gateway/server.*.test.ts hinzu und erwähnen Sie die Methode in der Dokumentation.

​
Verhalten der Swift-Codegenerierung

Der Swift-Generator erzeugt:
  • GatewayFrame-Enum mit req-, res-, event- und unknown-Fällen
  • Stark typisierte Payload-Structs/-Enums
  • ErrorCode-Werte, GATEWAY_PROTOCOL_VERSION und GATEWAY_MIN_PROTOCOL_VERSION
Unbekannte Frame-Typen werden für Vorwärtskompatibilität als Roh-Payloads beibehalten.

​
Versionierung + Kompatibilität

  • PROTOCOL_VERSION befindet sich in src/gateway/protocol/version.ts.
  • Clients senden minProtocol + maxProtocol; der Server lehnt Bereiche ab, die sein aktuelles Protokoll nicht einschließen.
  • Die Swift-Modelle behalten unbekannte Frame-Typen bei, um ältere Clients nicht zu beschädigen.

​
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 oberste GatewayFrame verwendet einen Discriminator auf type.
  • Methoden mit Nebeneffekten erfordern in der Regel ein idempotencyKey in den Parametern (Beispiel: send, poll, agent, chat.send).
  • agent akzeptiert optionale internalEvents für zur Laufzeit erzeugten Orchestrierungskontext (zum Beispiel Übergabe bei Abschluss von Subagent-/Cron-Tasks); behandeln Sie dies als interne API-Oberfläche.

​
Live-Schema-JSON

Das generierte JSON-Schema befindet sich im Repo unter dist/protocol.schema.json. Die veröffentlichte Rohdatei ist typischerweise verfügbar unter:

​
Wenn Sie Schemas ändern

  1. Aktualisieren Sie die TypeBox-Schemas.
  2. Registrieren Sie die Methode/das Ereignis in src/gateway/server-methods-list.ts.
  3. Aktualisieren Sie src/gateway/method-scopes.ts, wenn der neue RPC eine Operator- oder Node-Scope-Klassifizierung benötigt.
  4. Führen Sie pnpm protocol:check aus.
  5. Committen Sie das neu generierte Schema + die Swift-Modelle.

​
Verwandt