oclaw/openclaw/docs/reference/rpc.md
oliver dbbe3add6a 重构主控编排与运行时预热链路,统一工作区提示词/专家调度协议并补齐 wiki 记忆注入与写回闭环。
同时收敛启动与运维脚本默认行为(含 wiki worker)、更新 Admin 可观测性与相关测试,降低首轮时延并提高运行稳定性。

Made-with: Cursor
2026-04-26 08:34:33 +08:00

1.4 KiB

summary read_when title
RPC adapters for external CLIs (signal-cli, legacy imsg) and gateway patterns
Adding or changing external CLI integrations
Debugging RPC adapters (signal-cli, imsg)
RPC Adapters

RPC adapters

OpenClaw integrates external CLIs via JSON-RPC. Two patterns are used today.

Pattern A: HTTP daemon (signal-cli)

  • signal-cli runs as a daemon with JSON-RPC over HTTP.
  • Event stream is SSE (/api/v1/events).
  • Health probe: /api/v1/check.
  • OpenClaw owns lifecycle when channels.signal.autoStart=true.

See Signal for setup and endpoints.

Pattern B: stdio child process (legacy: imsg)

Note: For new iMessage setups, use BlueBubbles instead.

  • OpenClaw spawns imsg rpc as a child process (legacy iMessage integration).
  • JSON-RPC is line-delimited over stdin/stdout (one JSON object per line).
  • No TCP port, no daemon required.

Core methods used:

  • watch.subscribe → notifications (method: "message")
  • watch.unsubscribe
  • send
  • chats.list (probe/diagnostics)

See iMessage for legacy setup and addressing (chat_id preferred).

Adapter guidelines

  • Gateway owns the process (start/stop tied to provider lifecycle).
  • Keep RPC clients resilient: timeouts, restart on exit.
  • Prefer stable IDs (e.g., chat_id) over display strings.