Skip to main content
GET
Server-side doctor report

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Query Parameters

mode
enum<string>
default:full

quick runs only the cheap startup-safe checks

Available options:
full,
quick
probes
string

Comma-separated opt-in probe groups to include (currently ai, which spends a model call)

cli
string

Version of the calling CLI, echoed under surface.cli and compared with the server

mcp
string

Version of the calling MCP server, echoed under surface.mcp

ui
string

Version of the calling UI, echoed under surface.ui

Response

The report

doctorVersion
integer
ranAt
string

ISO-8601 instant

mode
enum<string>
Available options:
full,
quick
surface
object

Versions by surface (server always; cli, mcp, ui when passed)

summary
object
checks
object[]