System

Backend identity

Changed on

Return this backend's self-describing identity.

Unauthenticated and dependency-free so any client (an MCP server, the CLI, an agent) can read which backend it is bound to — local vs. a remote install — and label its responses accordingly.

get/instance

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /instance
  • Auth: none required

Response

Successful Response

backend'local' | 'remote' required

Operator-declared backend locality (server.backend): 'local' for a self-hosted install on the operator's own machine/network, 'remote' for a hosted install run elsewhere. A hint, not an authorization signal; defaults to 'local'.

broker_urlstring nullable

The broker (data plane) base URL a client should send execute traffic to, as configured by the operator (server.mcp.broker_url), with any userinfo stripped. Null when the platform cannot honestly advertise one: on a 'remote' backend a loopback-host value (the config default) describes the control plane's own machine, not an address any client can dial, so it is withheld rather than published as misleading guidance. Deployment metadata, not a secret — the broker URL is handed to every client expected to call it (issue #1249).

canonical_base_urlstring required

The instance's own canonical base URL (auth.canonical_base_url, else server.public_base_url, else the serving bind origin), with any userinfo stripped.

hoststring required

Host (and port, when the canonical base URL declares one) parsed from canonical_base_url; '' if unset or unparseable.

instance_idstring nullable

Opaque digest derived from the telemetry instance id — stable per install, but not the telemetry id itself. Null when telemetry has not resolved an id (e.g. telemetry disabled).

mcp_enabledboolean

Whether this instance serves the daemon-native Streamable HTTP MCP endpoint at /mcp (server.mcp.enabled). Lets clients (notably the UI's agent MCP card) advertise the HTTP transport only when it exists. Not sensitive: the endpoint's enabled state is observable by probing /mcp anyway.

Example response

{
  "backend": "remote",
  "broker_url": "https://broker.jentic.example.com",
  "canonical_base_url": "https://jentic.example.com",
  "host": "jentic.example.com",
  "instance_id": "5f2c9e0b7a41d8c3",
  "mcp_enabled": true
}

Changes