audit_repo

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

Discloses that it shallow-clones, returns an error (no fabrication), and shares output shape with audit_dependencies. No annotations exist, so description carries burden; it could mention more about side effects or prerequisites but is reasonably transparent.

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?

Three sentences, each with distinct purpose: action, usage context, and behavior. No wasted words, front-loaded with the core action.

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 (one required param, no output schema, no annotations), the description covers all essential aspects: purpose, when to use, error behavior, and output shape similarity. Sibling tools are referenced, providing adequate context.

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 adds value by explaining that the single parameter is a GitHub repo URL and contextualizing its use. It does not provide format constraints but the parameter is straightforward.

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 shallow-clones a public GitHub repo and returns a verified result. It distinguishes from sibling tools by specifying the input type (repo URL vs raw lockfile).

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 ('Use when you have a repo URL rather than a raw lockfile') and references the sibling tool audit_dependencies for comparison. Also provides an error guarantee.

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