Skip to content

health.ready

Can this process serve traffic: the registry and the index it built at start-up, already resident, and how the layer read. Only local initialisation — never an external provider, a database or another service, because a readiness check that probes a dependency fails a deployment for something that is not this process.

Can this process serve traffic: the registry and the index it built at start-up, already resident, and how the layer read. Only local initialisation — never an external provider, a database or another service, because a readiness check that probes a dependency fails a deployment for something that is not this process.

Exposure

Where this one definition is reachable. Absence is explicit: a surface not listed does not carry it.

surfaceas
MCP—
HTTPGET /api/v1/ready operationId health.ready
command line—

Schemas

The canonical input and output, from the Rust types; the MCP tool schema and the OpenAPI parameters and responses are derived from these.

input · Empty

No input.

No properties: the capability takes no input.

JSON Schema 
{
  "additionalProperties": false,
  "description": "No input.",
  "title": "Empty",
  "type": "object"
}

output · Readiness

The answer to "can this process serve traffic": the local initialisation a request would need, and nothing beyond this process. A readiness check that grew a dependency probe fails a deployment because an unrelated service is down.

propertytyperequireddescription
capabilities integer yes How many capabilities the registry holds; zero would mean nothing to serve.
layer reference yes Whether the layer read cleanly. A degraded layer is still served — the diagnostics are the point — so this reports rather than refuses.
objects integer yes How many objects the index holds. Read from the index this process built at start-up: it is already in memory, and reading it walks nothing.
ready boolean yes Whether every part below is in place.
version string yes This executable's version.
JSON Schema 
{
  "$defs": {
    "HealthStatus": {
      "description": "Where one dimension of the system stands. Ordered by severity, so the worst check\ndecides the whole.",
      "oneOf": [
        {
          "const": "ok",
          "description": "The engine that decides this dimension is satisfied.",
          "type": "string"
        },
        {
          "const": "warn",
          "description": "Nothing is broken and something is worth looking at.",
          "type": "string"
        },
        {
          "const": "fail",
          "description": "The engine that decides this dimension is not satisfied.",
          "type": "string"
        },
        {
          "const": "unknown",
          "description": "This process cannot decide it, and says so rather than reporting `ok`.",
          "type": "string"
        }
      ]
    }
  },
  "description": "The answer to \"can this process serve traffic\": the local initialisation a request\nwould need, and nothing beyond this process. A readiness check that grew a dependency\nprobe fails a deployment because an unrelated service is down.",
  "properties": {
    "capabilities": {
      "description": "How many capabilities the registry holds; zero would mean nothing to serve.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "layer": {
      "$ref": "#/$defs/HealthStatus",
      "description": "Whether the layer read cleanly. A degraded layer is still served — the diagnostics\nare the point — so this reports rather than refuses."
    },
    "objects": {
      "description": "How many objects the index holds. Read from the index this process built at\nstart-up: it is already in memory, and reading it walks nothing.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "ready": {
      "description": "Whether every part below is in place.",
      "type": "boolean"
    },
    "version": {
      "description": "This executable's version.",
      "type": "string"
    }
  },
  "required": [
    "ready",
    "version",
    "capabilities",
    "objects",
    "layer"
  ],
  "title": "Readiness",
  "type": "object"
}

Policies

benchmark
required — a target on every transport the exposure declares; the cases are the input type's
cache
disabled — every call runs the handler

Benchmark targets

Derived from the registry for this repository: one requirement per transport, and the cases the input type provides. The whole matrix is on the benchmarks page.

transportstatecasestargets
directcovered1default
httpcovered1default