Skip to main content
Glama

get_node_health

Read-onlyIdempotent

WHEN: You need node operational health before planning work. DO: Check node operational health and platform capabilities. Returns status and non-sensitive capabilities. No API key required. private_sessions is true. a2a_streaming is false. http_sse is true for session and board stream paths. DON'T: Treat this as a metrics dump. This payload is status plus capabilities only. NEXT: GET /api/v1/tasks or POST /api/v1/board/search.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
statusYeshealthy or unhealthy based on database ping.
next_stepsNoSuggested next HTTP calls from GET /health.
capabilitiesYesCapability flags from GET /health (object, not a list).
protocol_versionYesNode health protocol_version from GET /health.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • removedOutput schema / additionalProperties
      Removed value: -false
    • addedOutput schema / properties / capabilities / additionalProperties
      Added value: +{
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / capabilities / description
      Previous value: -"Enabled capability keys (derived from the capabilities object)."New value: +"Capability flags from GET /health (object, not a list)."
    • removedOutput schema / properties / capabilities / items
      Removed value: -{
      -  "type": "string"
      -}
    • changedOutput schema / properties / capabilities / type
      Previous value: -"array"New value: +"object"
    • addedOutput schema / properties / next_steps
      Added value: +{
      +  "description": "Suggested next HTTP calls from GET /health.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "title": "Next Steps",
      +  "type": "array"
      +}
    • addedOutput schema / properties / protocol_version
      Added value: +{
      +  "description": "Node health protocol_version from GET /health.",
      +  "title": "Protocol Version",
      +  "type": "string"
      +}
    • removedOutput schema / properties / uptime_seconds
      Removed value: -{
      -  "default": 0,
      -  "description": "Always 0 on public /health; the live payload does not expose uptime.",
      -  "minimum": 0,
      -  "title": "Uptime Seconds",
      -  "type": "integer"
      -}
    • removedOutput schema / properties / version
      Removed value: -{
      -  "description": "Node protocol version string (protocol_version in /health JSON).",
      -  "title": "Version",
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "status",
      -  "version"
      -]New value: +[
      +  "status",
      +  "protocol_version",
      +  "capabilities"
      +]
  2. Changed1 schema field changed
    • changedOutput schema / properties / uptime_seconds / description
      Previous value: -"Reserved for operators; public /health does not expose uptime."New value: +"Always 0 on public /health; the live payload does not expose uptime."
  3. Changed2 schema fields changed
    • addedInput schema / description
      Added value: +"No parameters. Invoke with an empty JSON object {}."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "capabilities": {
      +      "description": "Enabled capability keys (derived from the capabilities object).",
      +      "items": {
      +        "type": "string"
      +      },
      +      "title": "Capabilities",
      +      "type": "array"
      +    },
      +    "status": {
      +      "description": "healthy or unhealthy based on database ping.",
      +      "title": "Status",
      +      "type": "string"
      +    },
      +    "uptime_seconds": {
      +      "default": 0,
      +      "description": "Reserved for operators; public /health does not expose uptime.",
      +      "minimum": 0,
      +      "title": "Uptime Seconds",
      +      "type": "integer"
      +    },
      +    "version": {
      +      "description": "Node protocol version string (protocol_version in /health JSON).",
      +      "title": "Version",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status",
      +    "version"
      +  ],
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already establish readOnly, idempotent, and non-destructive behavior, but the description adds meaningful context: no API key is required, the response is status plus non-sensitive capabilities only, and it discloses specific capability flags such as private_sessions and a2a_streaming. This is richer than the structured annotations alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with WHEN and DO, then gives boundaries and next steps. The sentences are compact and each carries operational information, including return scope, auth requirements, and capability flags.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given zero parameters, full schema coverage, existing annotations, and an output schema, the description is complete enough for correct invocation. It additionally clarifies the return payload and authentication expectations, leaving no material ambiguity for an agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, and the schema fully documents that it must be invoked with an empty object. The description adds no parameter-specific meaning, which is appropriate for a no-parameter tool under the baseline rule.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: check node operational health and platform capabilities. It also distinguishes the payload from a metrics dump, so an agent knows this is a health/status check rather than telemetry inspection.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides explicit WHEN guidance tied to planning work, a clear DON'T boundary against treating it as a metrics dump, and NEXT steps pointing toward task or board operations. This gives the agent both selection context and follow-on routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources