diff --git a/docs/concepts/typebox.md b/docs/concepts/typebox.md index 410746a661d..a474afd1cc0 100644 --- a/docs/concepts/typebox.md +++ b/docs/concepts/typebox.md @@ -42,14 +42,15 @@ Client Gateway Common methods + events: -| Category | Examples | Notes | -| --------- | --------------------------------------------------------- | ---------------------------------- | -| Core | `connect`, `health`, `status` | `connect` must be first | -| Messaging | `send`, `agent`, `agent.wait`, `system-event` | side-effects need `idempotencyKey` | -| Chat | `chat.history`, `chat.send`, `chat.abort` | WebChat uses these | -| Sessions | `sessions.list`, `sessions.patch`, `sessions.delete` | session admin | -| Nodes | `node.list`, `node.invoke`, `node.pair.*` | Gateway WS + node actions | -| Events | `tick`, `presence`, `agent`, `chat`, `health`, `shutdown` | server push | +| Category | Examples | Notes | +| ---------- | ---------------------------------------------------------- | ---------------------------------- | +| Core | `connect`, `health`, `status` | `connect` must be first | +| Messaging | `send`, `agent`, `agent.wait`, `system-event`, `logs.tail` | side-effects need `idempotencyKey` | +| Chat | `chat.history`, `chat.send`, `chat.abort` | WebChat uses these | +| Sessions | `sessions.list`, `sessions.patch`, `sessions.delete` | session admin | +| Automation | `wake`, `cron.list`, `cron.run`, `cron.runs` | wake + cron control | +| Nodes | `node.list`, `node.invoke`, `node.pair.*` | Gateway WS + node actions | +| Events | `tick`, `presence`, `agent`, `chat`, `health`, `shutdown` | server push | Authoritative advertised **discovery** inventory lives in `src/gateway/server-methods-list.ts` (`listGatewayMethods`, `GATEWAY_EVENTS`). diff --git a/docs/gateway/protocol.md b/docs/gateway/protocol.md index a1977f5e276..90dbcefcfac 100644 --- a/docs/gateway/protocol.md +++ b/docs/gateway/protocol.md @@ -225,6 +225,9 @@ implemented in `src/gateway/server-methods/*.ts`. ### System and identity +- `health` returns the cached or freshly probed gateway health snapshot. +- `status` returns the `/status`-style gateway summary; sensitive fields are + included only for admin-scoped operator clients. - `gateway.identity.get` returns the gateway device identity used by relay and pairing flows. - `system-presence` returns the current presence snapshot for connected @@ -239,6 +242,8 @@ implemented in `src/gateway/server-methods/*.ts`. - `models.list` returns the runtime-allowed model catalog. - `usage.status` returns provider usage windows/remaining quota summaries. - `usage.cost` returns aggregated cost usage summaries for a date range. +- `doctor.memory.status` returns vector-memory / embedding readiness for the + active default agent workspace. - `sessions.usage` returns per-session usage summaries. - `sessions.usage.timeseries` returns timeseries usage for one session. - `sessions.usage.logs` returns usage log entries for one session. @@ -256,6 +261,13 @@ implemented in `src/gateway/server-methods/*.ts`. - `voicewake.get` returns the stored wake-word triggers. - `voicewake.set` updates wake-word triggers and broadcasts the change. +### Messaging and logs + +- `send` is the direct outbound-delivery RPC for channel/account/thread-targeted + sends outside the chat runner. +- `logs.tail` returns the configured gateway file-log tail with cursor/limit and + max-byte controls. + ### Talk and TTS - `talk.config` returns the effective Talk config payload; `includeSecrets` @@ -365,6 +377,8 @@ implemented in `src/gateway/server-methods/*.ts`. - `exec.approval.request` and `exec.approval.resolve` cover one-shot exec approval requests. +- `exec.approval.waitDecision` waits on one pending exec approval and returns + the final decision (or `null` on timeout). - `exec.approvals.get` and `exec.approvals.set` manage gateway exec approval policy snapshots. - `exec.approvals.node.get` and `exec.approvals.node.set` manage node-local exec @@ -374,9 +388,34 @@ implemented in `src/gateway/server-methods/*.ts`. #### Other major families -- automation: `cron.*` +- automation: + - `wake` schedules an immediate or next-heartbeat wake text injection + - `cron.list`, `cron.status`, `cron.add`, `cron.update`, `cron.remove`, + `cron.run`, `cron.runs` - skills/tools: `skills.*`, `tools.catalog`, `tools.effective` +### Common event families + +- `chat`: UI chat updates such as `chat.inject` and other transcript-only chat + events. +- `session.message` and `session.tool`: transcript/event-stream updates for a + subscribed session. +- `sessions.changed`: session index or metadata changed. +- `presence`: system presence snapshot updates. +- `tick`: periodic keepalive / liveness event. +- `health`: gateway health snapshot update. +- `heartbeat`: heartbeat event stream update. +- `cron`: cron run/job change event. +- `shutdown`: gateway shutdown notification. +- `node.pair.requested` / `node.pair.resolved`: node pairing lifecycle. +- `node.invoke.request`: node invoke request broadcast. +- `device.pair.requested` / `device.pair.resolved`: paired-device lifecycle. +- `voicewake.changed`: wake-word trigger config changed. +- `exec.approval.requested` / `exec.approval.resolved`: exec approval + lifecycle. +- `plugin.approval.requested` / `plugin.approval.resolved`: plugin approval + lifecycle. + ### Node helper methods - Nodes may call `skills.bins` to fetch the current list of skill executables