github_repos_delete_autolink

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

With no annotations, the description must fully disclose behavior. It only states the action ('delete') without describing side effects, reversibility, error handling, or required permissions. The verb implies destructiveness but lacks depth.

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, concise sentence (7 words) that is front-loaded with the action. Every word contributes to the purpose, with no extraneous information.

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?

For a simple delete operation with three required parameters and no output schema, the description is minimally adequate. However, it lacks context about return values (e.g., success indicator) and common prerequisites, leaving some gaps for an AI agent.

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?

Although schema coverage is 100%, the parameter descriptions are trivial (just parameter names). The description adds no extra meaning about how to obtain 'autolink_id' or what constitutes a valid autolink. It fails to enhance understanding beyond the schema.

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 'Delete an autolink reference from a repository' uses a specific verb ('Delete') and resource ('autolink reference'), clearly distinguishing it from sibling tools like create, get, or list autolinks. The scope 'from a repository' adds clarity.

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 provides no guidance on when to use this tool versus alternatives, such as prerequisites (e.g., admin permissions), or circumstances under which deletion is appropriate. It lacks any context about usage context or exclusions.

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