readme_add_badges

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

There are no annotations, so the description carries the full burden. It states the action 'Add' but doesn't disclose how badges are inserted (e.g., placement at top), whether api_key is needed for certain badge services, whether existing badges are replaced or appended, or what happens if readme_content lacks a suitable heading. A single sentence leaves most behavioral traits unspecified.

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?

One sentence, front-loaded with the action and badge categories. It earns its place, though it could add a brief usage hint without becoming bloated.

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?

No annotations, no output schema, and a simple but real dependency between repo_url/api_key and badge generation. The description doesn't explain whether badges parameter is optional (it is not in required), how badges are rendered, or what happens if repo_url is missing. For an agent to call this correctly, it needs more context about which params matter for which badge types.

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 description coverage is 100%, so each parameter has an explicit description. The tool description adds only the badge type examples (CI, coverage, version, license), which helps clarify the 'badges' parameter. This is baseline-3 territory because the schema already does the heavy lifting.

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 'Add status badges (CI, coverage, version, license) to an existing README' clearly states the verb (add), resource (README), and the types of badges. It distinguishes from the sibling readme_generate (which likely creates a README) and readme_add_api_reference (which adds a different section), though it doesn't explicitly name those 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?

The description implies the tool is for augmenting an existing README with badges, and the required readme_content parameter reinforces that. However, it gives no explicit guidance on when to choose this over readme_generate or readme_add_api_reference, nor does it mention prerequisites such as a repo_url for generating links.

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