pio_clean

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

With no annotations, the description carries the full burden of disclosing destructive behavior. It clearly states that build artifacts are deleted and that full=true also removes downloaded dependencies, adding meaningful behavioral detail beyond a generic 'clean' label. It does not mention irreversibility, but the deletion semantics are explicit.

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?

One tightly-written sentence front-loads the primary action and immediately clarifies the key flag. Every part is informative, with no filler or repetition.

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?

The tool is a simple 3-parameter, no-required-parameter operation, and an output schema exists. The description covers the core destructive action and full-clean behavior; only project_dir is left implicit, which is a minor gap given the descriptive property name and low complexity.

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%, so the description must compensate. It explains the meaning of env ('for an env') and the critical full flag ('full=true also removes downloaded dependencies'), but it does not mention project_dir at all, leaving that parameter to be inferred from its title and schema default.

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 names a specific action ('Delete build artifacts'), a clear object ('build artifacts'), and a scope ('for an env'), with the underlying command (`pio run -t clean`) as evidence. It is immediately distinguishable from sibling build/run/package tools even without naming them.

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?

The description implies when to use the tool: when you want to remove build artifacts, and optionally dependencies with full=true. However, it gives no explicit guidance on when not to use it or how it relates to similar operations like pio_pkg_uninstall, so the agent must infer usage from purpose alone.

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