Project Badge

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

Annotations already declare readOnly, idempotent, and non-destructive hints. The description adds useful behavioral context: the output is an SVG URL, it reflects the latest buildset result, and the tenant parameter defaults from the environment. This goes beyond the annotation hints.

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 exceptionally concise: one purpose sentence followed by a structured arguments list. Every sentence earns its place with relevant details, and the purpose is front-loaded.

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?

With an output schema present, the description only needs to cover purpose and parameters, which it does adequately. Minor ambiguity around the exact semantics of pipeline/branch filters remains, but the tool is simple enough that the provided details are sufficient for correct invocation.

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 has 0% description coverage, so the description must compensate. It does: project includes an example format ('org/repo'), tenant notes the env default, and pipeline/branch are described as filters. While 'filter' is somewhat vague, the added context clearly aids interpretation.

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 'Get a status badge URL (SVG) for a project's latest buildset result' – a specific verb (get), resource (badge URL), and scope (latest buildset). This distinguishes it from sibling tools like get_build or get_status.

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 gives no explicit guidance on when to use this tool vs alternatives, nor does it mention exclusions. The intended use is implied by the purpose (obtaining badge URLs), but no comparison to similar status tools is provided.

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