gograph_orphans

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

Adds significant detail beyond annotations: local static analysis, no side effects, no auth needed, no rate limits, zero destructive modifications. Annotations already indicate read-only and idempotent, but description enriches context.

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?

Efficiently organized into labeled sections (BEHAVIOR & SAFETY, USAGE GUIDELINES, COMPLETENESS). No redundant information; every sentence is purposeful.

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?

Despite having no output schema, the description fully explains what the tool returns. Combined with comprehensive behavioral and usage details, it leaves no gaps for an agent to execute correctly.

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?

With zero parameters, the schema provides no param info. The description compensates by detailing the return value (list of orphan symbols, packages, file definitions), fully covering what the agent needs.

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 it finds unreachable functions and methods, specifying entry points like main, HTTP routes, and exported symbols. It distinguishes from sibling tools, e.g., gograph_usages for specific symbol usage.

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 call (cleanup, dead code removal) and when not to (use gograph_usages for specific checks). Provides clear alternative guidance.

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