check_documentation_health

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

The description adds that the tool performs connectivity tests and returns cache statistics, which supplements the readOnlyHint annotation. However, it does not disclose any other behaviors (e.g., network calls) beyond what is obvious.

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 reasonably concise with two sentences, but includes a Returns section that partially repeats the purpose, adding slight redundancy.

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?

Given no parameters and only a readOnly annotation, the description adequately covers the tool's purpose and return type. It could mention that it is a no-side-effect operation, but the annotation already implies safeness.

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?

No parameters exist in the input schema, so schema coverage is 100%. The description adds no parameter information, but the baseline for 0 parameters is 4.

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 clearly states the tool checks the health and connectivity of a documentation fetching service, with a specific verb ('checks') and resource ('documentation fetching service'). It distinguishes from sibling tools like check_spec_health by specifying the target service.

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 description provides general context for when to use the tool (to verify service health), but does not give explicit when-not-to-use guidance or mention alternatives among siblings.

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