github_get_release

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

With no annotations, the description offers minimal behavioral disclosure. It doesn't explain the conditional requirement for release_id/tag, what happens if both are provided, or error handling. The read-only nature is implied but not explicit.

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 minimal, with a one-sentence purpose and an args list. Every line contributes useful information without redundancy.

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 has 5 parameters and an output schema. The description explains parameters but leaves logical constraints ambiguous (e.g., one of release_id/tag should be provided). It also doesn't cover mutual exclusivity behavior.

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?

All five parameters are described with concise explanations, adding meaning beyond the bare schema. The key distinction between release_id and tag is clarified with 'use either this or tag'.

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 retrieves details for a specific release, distinguishing it from list_releases and get_latest_release by the word 'specific'. The verb 'get' and resource 'release' are explicit.

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 guidance is provided on when to choose this tool over siblings like get_latest_release or list_releases. The only hint, 'use either this or tag', addresses parameter selection, not tool selection.

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