getCompilationErrors

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

The description indicates side effects (running compile), but lacks details on potential performance impact, failure modes, or whether it modifies project state. No annotations provided to compensate.

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 extremely concise at 9 words, front-loading the purpose. However, it omits critical details, making it insufficient for effective use.

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 complexity (compilation side effects, no output schema), the description is incomplete. It does not describe the return format or explicitly differentiate from similar siblings, leaving gaps for the 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?

Schema description coverage is 0%. The description does not explain the two parameters (module, profile), leaving the agent without guidance on how to use them.

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 runs compile and returns only a structured error list, distinguishing it from siblings like compileProject or getFailedTests. However, it could be more specific about what 'compile' entails (e.g., Maven compile).

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?

No guidance on when to use this tool versus alternatives like compileProject or getFailedTests. Prerequisites or context (e.g., project must be open) are not mentioned.

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