find_circular_dependencies

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

Discloses algorithm (Tarjan's SCC) and output details, and states prerequisite. Without annotations, it could mention that it is read-only and does not modify project state, but the existing details provide adequate 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?

Concise and front-loaded with the main purpose. Usage examples are helpful, though repetition of 'USAGE' could be streamlined.

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?

Explains output as list of cycles with cycle paths and affected packages, and notes prerequisite. Lacks details on behavior when no cycles exist, but overall complete for a tool without output schema.

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 covers 100% of parameters with descriptions. The description adds usage examples but does not significantly 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 clearly states 'Detect cycles in packages' with a specific verb and resource. It distinguishes itself from sibling tools like get_dependency_graph by focusing on cycle detection rather than general dependencies.

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?

Provides usage examples with and without parameters, and explicitly requires load_project to be called first. Lacks explicit when-not-to-use or alternatives, but the context is clear.

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