get_doc_health

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

Annotations already indicate readOnlyHint=true, so the read-only nature is covered. The description adds a list of return metrics but doesn't clarify if the tool is always allowed or any rate limits. It does not contradict annotations.

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 a single sentence with a list, which is concise and front-loaded. However, the dense list could be more structured with bullet points for readability.

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 output schema, the description lists return fields but lacks explanation of what each metric means or how to interpret them. With many siblings, more context on when this tool is preferred would improve completeness.

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 only parameter 'repo' has no description in the schema (0% coverage). The description does not explain what 'repo' represents (e.g., repository identifier), leaving the agent to infer its meaning. This is a significant gap.

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 'One-shot index health diagnostics' and enumerates the specific metrics returned (section_count, doc_count, etc.), making the tool's purpose unambiguous. It distinguishes itself from siblings like 'get_index_overview' by specifying the exact health indicators.

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?

No explicit guidance on when or when not to use this tool. The term 'one-shot' hints at a quick overview, but there's no comparison to alternatives like 'doc_health_radar' or 'get_index_overview'. The description lacks usage context.

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