Skip to main content
/mcp/sse is an SSE endpoint that delivers tool-execution results from the Gateway in real time. It’s used for dashboard live views, multi-client collaboration, and external observability integrations.

Request

Event types

event: ready

Emitted once right after connecting. Identifiable later via clientId (sse_ prefix).

Heartbeat

An SSE comment (: keepalive) is sent periodically to prevent NAT/proxy timeouts.

event: messagegateway/toolResult

The tools/call result is delivered only to the relevant client (tenant). It is not broadcast to everyone, in order to prevent cross-tenant data leakage. To target a client, pass _clientId along with the tools/call.

event: byoapi

The progress of a BYOAPI registration job is delivered to the client that requested the registration.

cURL

The -N (—no-buffer) flag gives you real-time output.

Node.js (EventSource)

Operational notes

  • Events are delivered only to the connected client (tenant) and never leak to other tenants.
  • On 5xx errors, use EventSource or an equivalent library so the client reconnects automatically.