Skip to main content
Glama

Check server health

health
Read-onlyIdempotent

Returns server health status, version, and datasource connectivity. A person who is not an administrator receives only that this server answers and which project, whatever their Role's level: no version, no required metadata-schema version, and no datasource entry, and no datasource is probed to answer them. An administrator, an agent, and an API key receive the full report.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "health"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Goes well beyond annotations by disclosing that the response is permission-scoped: non-administrators (regardless of Role level) get only reachability and project, with no version, metadata-schema version, or datasource data, while administrators, agents, and API keys get the full report. It also discloses that no datasource is probed on the restricted path, which tells the agent about side effects and reduced data the annotations alone would not reveal.

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

Conciseness3/5

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

The lead sentence is tight and front-loaded, but the second sentence is tangled and repetitive ('no datasource entry, and no datasource is probed to answer them', 'whatever their Role's level') and could state the same conditional logic far more cleanly.

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

Completeness4/5

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

With no parameters, no output schema, and no nested objects, the description carries the burden well by naming the returned fields and the permission-dependent variation. It does not describe the shape or naming of the report or success/failure signaling, which leaves a minor gap for a tool with no output schema.

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 takes no parameters, so there is nothing for the description to disambiguate and the schema is trivially complete. Baseline of 4 applies for a zero-parameter tool.

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?

States a specific verb and resource ('Returns server health status, version, and datasource connectivity') and enumerates exactly what is returned. No sibling among the named tools performs a health check, so there is no ambiguity to resolve.

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

Usage Guidelines3/5

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

Implies the diagnostic context (checking server answering, version, datasource reachability), but never states explicitly when to call it or what to do with the result. There is no competing sibling, so no exclusion guidance is needed, but the when-to-use framing remains implicit.

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