get_quick_fixes

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

Lists supported fix categories (e.g., UndefinedType, UnusedImport) and notes zero-based line numbers. No annotations provided, so description carries burden. Not misleading, but could mention if fixes are computation-heavy.

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 structured with usage, output format, and fix categories in bullet list. No redundancy, every sentence adds value.

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?

Covers usage, output format, prerequisite, and supported fix types. Lacks error scenarios or details about behavior when no fixes available, but sufficient for typical use.

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 all parameters with descriptions. Description adds usage example and reinforces zero-based line info, but does not significantly extend beyond schema (100% coverage).

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?

Clearly states it lists available fixes for a problem at a position. Distinguishes from siblings like 'apply_quick_fix' and other analysis tools.

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 example, required parameters, and prerequisite (load_project). Does not explicitly state when not to use or compare alternatives, but gives clear invocation guidance.

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