scan

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

No annotations provided; description only states it's an alias, with no disclosure of behavioral traits (e.g., mutability, permissions, side effects). Schema shows scan modes but description lacks elaboration.

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?

Extremely concise: two sentences, no wasted words. Front-loaded with key point 'ultra-short alias'.

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?

Adequate for a simple alias tool given full schema coverage, but lacks context on return values, behavior for different scan modes, and overall tool purpose beyond being an alias.

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 coverage is 100%, so baseline is 3. Description adds no extra meaning to the parameters already documented in 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?

Description clearly states it's an alias for a quick scan, referencing megalinter_quick_action. It identifies the verb (scan) and resource (quick scan) but does not differentiate from sibling tools in detail.

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?

Implies usage for quick scans via 'Ultra-short alias', but no explicit when/when-not or alternatives beyond referencing the equivalent function.

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