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

With no annotations, the description carries the full burden, but it only says 'payload' without specifying the format (JSON/SVG) or any behaviors like failure modes, caching, or rate limits. It does not disclose what the endpoint returns beyond being a badge payload, which is a significant gap for an agent.

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 focused sentence followed by a metric list. It is front-loaded with the purpose and contains no superfluous wording. The list is necessary because it enumerates allowed values.

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?

The tool is simple (one param, no output schema), but the description omits crucial details about the actual payload structure required by shields.io (e.g., JSON schema with label, message, color). An agent would not know how to interpret or consume the response. Given no output schema, this is a notable gap.

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 schema provides an enum for the single parameter, so the parameter is self-explanatory. The description adds the context that these are 'catalogue metrics' and lists them, which is redundant with the enum but adds minor semantic framing. Since schema coverage is 0%, the description provides some value but not much beyond restating the enum.

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 produces a shields.io endpoint payload for catalogue metrics, intended for README badges. It distinguishes itself from sibling data tools (trdefi_stats, trdefi_positions, etc.) by its purpose (display vs. raw data retrieval), though it doesn't explicitly name the alternatives.

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?

Usage context is implied: 'so a README can show live figures' suggests when to use it (for badges), but there is no explicit guidance on when not to use it or when to prefer a sibling tool. The distinction from data-returning tools is implicit rather than stated.

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