get_badge_link

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

Discloses key behaviors: no scan, no network call, no auth, and returns JSON with badgeUrl. However, no mention of error handling for invalid domains or edge cases, but acceptable for a simple URL construction tool.

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?

Every sentence adds value: purpose, behavior, return format, style options, sibling comparison. No redundancy. Well-structured and 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?

Given the tool's simplicity (2 params, no output schema), the description is complete. It explains what it does, what it returns, options, and differentiation from a sibling.

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?

Schema covers domain with example, style has enum but no description in schema. The description adds meaning by listing the style options, compensating for the schema 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 the tool builds a direct SVG badge URL for a domain's security score, with specifics like pure URL construction, no scan triggered, and no auth. It distinguishes from sibling get_pdf_report_link.

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?

Explicitly states when to use this tool (for embeddable status badges) and when not (use get_pdf_report_link for downloadable report URL). Also lists style options for customization.

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