TypeBox

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.

​

แบบจำลองทางความคิด (30 วินาที)

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

​

ตำแหน่งของสคีมา

• แหล่งที่มา: src/gateway/protocol/schema.ts
• ตัวตรวจสอบความถูกต้องขณะรัน (AJV): src/gateway/protocol/index.ts
• รีจิสทรีฟีเจอร์/discovery ที่ประกาศ: src/gateway/server-methods-list.ts
• Server handshake + การ dispatch เมธอด: src/gateway/server.impl.ts
• ไคลเอนต์ Node: src/gateway/client.ts
• JSON Schema ที่สร้างขึ้น: dist/protocol.schema.json
• โมเดล Swift ที่สร้างขึ้น: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​

ไปป์ไลน์ปัจจุบัน

• pnpm protocol:gen
  • เขียน JSON Schema (draft-07) ไปที่ dist/protocol.schema.json
• pnpm protocol:gen:swift
  • สร้างโมเดล Gateway สำหรับ Swift
• pnpm protocol:check
  • รันตัวสร้างทั้งสองตัวและตรวจสอบว่า output ถูก commit แล้ว

​

วิธีใช้สคีมาขณะรัน

• ฝั่งเซิร์ฟเวอร์: เฟรมขาเข้าทุกเฟรมถูกตรวจสอบด้วย AJV โดย handshake จะยอมรับเฉพาะคำขอ connect ที่ params ตรงกับ ConnectParams
• ฝั่งไคลเอนต์: ไคลเอนต์ JS ตรวจสอบเฟรมเหตุการณ์และเฟรมการตอบกลับก่อนใช้งาน
• การค้นพบฟีเจอร์: Gateway ส่งรายการ features.methods และ features.events แบบระมัดระวังใน hello-ok จาก listGatewayMethods() และ GATEWAY_EVENTS
• รายการ discovery นั้นไม่ใช่ dump ที่สร้างขึ้นของ helper ทุกตัวที่เรียกได้ใน coreGatewayHandlers; helper RPC บางตัวถูกใช้งานใน src/gateway/server-methods/*.ts โดยไม่ได้ถูกแจกแจงในรายการฟีเจอร์ที่ประกาศ

​

ตัวอย่างเฟรม

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

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

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

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

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

​

ไคลเอนต์ขั้นต่ำ (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: 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();
  }
});

​

ตัวอย่างแบบครบขั้นตอน: เพิ่มเมธอดตั้งแต่ต้นจนจบ

1. สคีมา (แหล่งความจริง)

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. การตรวจสอบความถูกต้อง

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

3. พฤติกรรมฝั่งเซิร์ฟเวอร์

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

4. สร้างใหม่

pnpm protocol:check

5. การทดสอบ + เอกสาร

​

พฤติกรรมการสร้างโค้ด Swift

• enum GatewayFrame ที่มี case req, res, event และ unknown
• structs/enums ของ payload ที่มี type ชัดเจน
• ค่า ErrorCode, GATEWAY_PROTOCOL_VERSION และ GATEWAY_MIN_PROTOCOL_VERSION

​

การกำหนดเวอร์ชัน + ความเข้ากันได้

• PROTOCOL_VERSION อยู่ใน src/gateway/protocol/version.ts
• ไคลเอนต์ส่ง minProtocol + maxProtocol; เซิร์ฟเวอร์จะปฏิเสธช่วงที่ไม่รวมโปรโตคอลปัจจุบันของเซิร์ฟเวอร์
• โมเดล Swift เก็บชนิดเฟรมที่ไม่รู้จักไว้เพื่อหลีกเลี่ยงการทำให้ไคลเอนต์รุ่นเก่าเสียหาย

​

รูปแบบและข้อตกลงของสคีมา

• อ็อบเจ็กต์ส่วนใหญ่ใช้ additionalProperties: false เพื่อให้ payload เข้มงวด
• NonEmptyString เป็นค่าเริ่มต้นสำหรับ ID และชื่อเมธอด/เหตุการณ์
• GatewayFrame ระดับบนสุดใช้ discriminator บน type
• เมธอดที่มี side effect มักต้องมี idempotencyKey ใน params (ตัวอย่าง: send, poll, agent, chat.send)
• agent รับ internalEvents แบบไม่บังคับสำหรับบริบท orchestration ที่สร้างขณะรัน (เช่น การส่งมอบเมื่อ subagent/cron task เสร็จสิ้น); ให้ถือว่านี่เป็นพื้นผิว API ภายใน

​

JSON สคีมาแบบสด

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

​

เมื่อคุณเปลี่ยนสคีมา

1. อัปเดตสคีมา TypeBox
2. ลงทะเบียนเมธอด/เหตุการณ์ใน src/gateway/server-methods-list.ts
3. อัปเดต src/gateway/method-scopes.ts เมื่อ RPC ใหม่ต้องการการจัดหมวดหมู่ scope ของผู้ปฏิบัติการหรือโหนด
4. รัน pnpm protocol:check
5. Commit สคีมาและโมเดล Swift ที่สร้างใหม่

​

ที่เกี่ยวข้อง

• โปรโตคอล rich output
• อะแดปเตอร์ RPC