​

TypeBox sebagai sumber kebenaran protokol

​

Model mental (30 detik)

• 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 ----------|

​

Lokasi skema berada

• Sumber: src/gateway/protocol/schema.ts
• Validator runtime (AJV): src/gateway/protocol/index.ts
• Registry discovery/fitur yang diiklankan: src/gateway/server-methods-list.ts
• Handshake server + dispatch method: src/gateway/server.impl.ts
• Klien node: src/gateway/client.ts
• JSON Schema yang dihasilkan: dist/protocol.schema.json
• Model Swift yang dihasilkan: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​

Pipeline saat ini

• pnpm protocol:gen
  • menulis JSON Schema (draft‑07) ke dist/protocol.schema.json
• pnpm protocol:gen:swift
  • menghasilkan model gateway Swift
• pnpm protocol:check
  • menjalankan kedua generator dan memverifikasi bahwa output sudah dikomit

​

Cara skema digunakan saat runtime

• Sisi server: setiap frame masuk divalidasi dengan AJV. Handshake hanya menerima request connect yang parameternya cocok dengan ConnectParams.
• Sisi klien: klien JS memvalidasi frame event dan response sebelum menggunakannya.
• Discovery fitur: Gateway mengirim daftar konservatif features.methods dan features.events dalam hello-ok dari listGatewayMethods() dan GATEWAY_EVENTS.
• Daftar discovery tersebut bukan dump yang dihasilkan dari setiap helper yang dapat dipanggil di coreGatewayHandlers; beberapa helper RPC diimplementasikan di src/gateway/server-methods/*.ts tanpa dicantumkan dalam daftar fitur yang diiklankan.

​

Contoh frame

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

​

Klien minimal (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();
  }
});

​

Contoh lengkap: tambahkan method dari ujung ke ujung

1. Skema (sumber kebenaran)

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. Validasi

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

3. Perilaku server

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

4. Hasilkan ulang

pnpm protocol:check

5. Tes + dokumentasi

​

Perilaku Swift codegen

• enum GatewayFrame dengan case req, res, event, dan unknown
• struct/enum payload yang bertipe kuat
• nilai ErrorCode dan GATEWAY_PROTOCOL_VERSION

​

Pemberian versi + kompatibilitas

• PROTOCOL_VERSION berada di src/gateway/protocol/schema.ts.
• Klien mengirim minProtocol + maxProtocol; server menolak jika tidak cocok.
• Model Swift mempertahankan jenis frame yang tidak dikenal agar klien lama tidak rusak.

​

Pola dan konvensi skema

• Sebagian besar objek menggunakan additionalProperties: false untuk payload yang ketat.
• NonEmptyString adalah default untuk ID dan nama method/event.
• GatewayFrame tingkat atas menggunakan discriminator pada type.
• Method dengan efek samping biasanya memerlukan idempotencyKey di params (contoh: send, poll, agent, chat.send).
• agent menerima internalEvents opsional untuk konteks orkestrasi yang dihasilkan runtime (misalnya serah terima penyelesaian tugas subagen/cron); perlakukan ini sebagai permukaan API internal.

​

JSON skema live

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

​

Saat Anda mengubah skema

1. Perbarui skema TypeBox.
2. Daftarkan method/event di src/gateway/server-methods-list.ts.
3. Perbarui src/gateway/method-scopes.ts saat RPC baru memerlukan klasifikasi cakupan operator atau node.
4. Jalankan pnpm protocol:check.
5. Komit skema yang dihasilkan ulang + model Swift.