​

TypeBox como fuente de verdad del protocolo

​

Modelo mental (30 segundos)

• Solicitud: { type: "req", id, method, params }
• Respuesta: { type: "res", id, ok, payload | error }
• Evento: { type: "event", event, payload, seq?, stateVersion? }

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

​

Dónde viven los esquemas

• Origen: src/gateway/protocol/schema.ts
• Validadores en tiempo de ejecución (AJV): src/gateway/protocol/index.ts
• Registro anunciado de funciones/discovery: src/gateway/server-methods-list.ts
• Handshake del servidor + despacho de métodos: src/gateway/server.impl.ts
• Cliente de nodo: src/gateway/client.ts
• JSON Schema generado: dist/protocol.schema.json
• Modelos Swift generados: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​

Canalización actual

• pnpm protocol:gen
  • escribe JSON Schema (draft‑07) en dist/protocol.schema.json
• pnpm protocol:gen:swift
  • genera modelos Swift del gateway
• pnpm protocol:check
  • ejecuta ambos generadores y verifica que la salida esté confirmada

​

Cómo se usan los esquemas en tiempo de ejecución

• Lado del servidor: cada marco entrante se valida con AJV. El handshake solo acepta una solicitud connect cuyos parámetros coincidan con ConnectParams.
• Lado del cliente: el cliente JS valida marcos de evento y respuesta antes de usarlos.
• Discovery de funciones: el Gateway envía una lista conservadora features.methods y features.events en hello-ok desde listGatewayMethods() y GATEWAY_EVENTS.
• Esa lista de discovery no es un volcado generado de cada helper invocable en coreGatewayHandlers; algunos RPC auxiliares están implementados en src/gateway/server-methods/*.ts sin estar enumerados en la lista anunciada de funciones.

​

Marcos de ejemplo

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

​

Cliente mínimo (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();
  }
});

​

Ejemplo trabajado: añadir un método de extremo a extremo

1. Esquema (fuente de verdad)

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. Validación

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

3. Comportamiento del servidor

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

4. Regenerar

pnpm protocol:check

5. Pruebas + documentación

​

Comportamiento de la generación de código Swift

• GatewayFrame enum con casos req, res, event y unknown
• Structs/enums de carga útil con tipado fuerte
• Valores ErrorCode y GATEWAY_PROTOCOL_VERSION

​

Versionado + compatibilidad

• PROTOCOL_VERSION vive en src/gateway/protocol/schema.ts.
• Los clientes envían minProtocol + maxProtocol; el servidor rechaza incompatibilidades.
• Los modelos Swift conservan tipos de marco desconocidos para evitar romper clientes más antiguos.

​

Patrones y convenciones de esquemas

• La mayoría de objetos usan additionalProperties: false para cargas útiles estrictas.
• NonEmptyString es el valor predeterminado para IDs y nombres de método/evento.
• El GatewayFrame de nivel superior usa un discriminador en type.
• Los métodos con efectos secundarios normalmente requieren un idempotencyKey en los parámetros (ejemplo: send, poll, agent, chat.send).
• agent acepta internalEvents opcionales para contexto de orquestación generado por el entorno de ejecución (por ejemplo, transferencia de finalización de tareas de subagente/cron); trátalo como una superficie de API interna.

​

JSON Schema activo

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

​

Cuando cambies esquemas

1. Actualiza los esquemas TypeBox.
2. Registra el método/evento en src/gateway/server-methods-list.ts.
3. Actualiza src/gateway/method-scopes.ts cuando el nuevo RPC necesite clasificación de alcance de operador o nodo.
4. Ejecuta pnpm protocol:check.
5. Confirma el esquema regenerado + los modelos Swift.