get_site_health
Health level, score and uptime of a site. Requires an API key (Free keys work).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | Site id returned by list_sites. |
Health level, score and uptime of a site. Requires an API key (Free keys work).
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | Site id returned by list_sites. |
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 openWorldHint=false, so safety is covered. The description usefully adds the API-key requirement and free-tier note, but says nothing about freshness of the health data, caching, or failure behavior when a site is unreachable.
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?
Two compact sentences with the returned values front-loaded and the auth caveat second. No filler, though the first sentence's fragmentary grammar costs a little clarity.
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 one-parameter read tool with no output schema, naming the returned fields (health level, score, uptime) and the auth requirement covers what an agent needs to call it. Remaining gaps are minor.
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?
There is a single required parameter with 100% schema coverage, and the schema already explains that siteId comes from list_sites. The description adds no further meaning such as format or scope, so the baseline of 3 applies.
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?
Names the resource (a site) and enumerates what is retrieved — health level, score and uptime — which is enough to distinguish it from siblings like list_sites or check_install. It stops short of an explicit verb (e.g. 'Get the health...'), so it reads as a noun fragment rather than a full statement of action.
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 only usage condition given is the authentication prerequisite ('Requires an API key (Free keys work)'). There is no guidance on when to prefer this over check_install or how it relates to list_sites (which supplies the siteId), so usage is implied rather than directed.
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.