Service health status
system_healthService health status
GET /api/v1/health
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
system_healthService health status
GET /api/v1/health
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, and the description does not contradict them. However, the description adds no behavioral detail beyond the endpoint, such as response format, availability semantics, or authentication needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short, but the first line repeats the tool title verbatim, leaving only the endpoint line as new information. It is appropriately small yet wastes its first line on duplication.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-parameter, read-only health check the description contains enough to invoke the tool, but with no output schema it never states what response the agent should expect. It is adequate but leaves return semantics implicit.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters and the schema is complete, so there are no parameter semantics to document. A baseline of 4 is appropriate because the description is not burdened with explaining inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description identifies the resource as the service health endpoint and specifies the GET method, so an agent can tell this is a health status check. It is clear but does not actively distinguish it from sibling tools like system_meta.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The title and endpoint imply the tool is for retrieving service health status, so usage can be inferred. It offers no explicit guidance on when to use it versus alternatives or any caveats.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.