pio_test

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

With no annotations, the description carries the full burden. It discloses that native envs run on the host, embedded envs build, flash, and read over serial, and that without_uploading changes behavior. This is substantial behavioral disclosure. It does not mention potential side effects of flashing (e.g., overwriting device state), but it does say 'flash' explicitly, so the agent is aware of that action.

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?

Three sentences with no filler. The first sentence states the action, framework, and output. The second covers test location and env behavior. The third covers filter/ignore syntax. Everything earns its place and is front-loaded with the core purpose.

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 has 8 parameters and no annotation or schema descriptions. The description explains the core workflow (test location, native vs embedded, filtering) but omits details on env selection, project_dir, upload_port, and without_building. An output schema exists, so return format is covered, but the description is not fully complete for a tool of this complexity; it is adequate but leaves gaps an agent must infer.

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 0%, so the description must compensate. It explains filter/ignore with glob pattern examples and without_uploading for embedded envs, but leaves env, verbose, project_dir, upload_port, and without_building unexplained. Given 8 parameters, this is partial coverage; it helps with the most nuanced ones but does not fully compensate for the schema gap.

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 it runs PlatformIO unit tests, specifies the Unity framework, and describes the return format (per-case pass/fail with file, line, message). It distinguishes itself from siblings like pio_build and pio_run_target by focusing specifically on test execution and result reporting.

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 clear context on when to use it (running unit tests) and gives a practical hint (set without_uploading=true to only build embedded tests). It does not explicitly name alternative tools or say when not to use it, but the purpose is specific enough that an agent can infer its role relative to siblings.

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