pio_run_target

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

With no annotations provided, the description carries the burden of behavioral disclosure and does a solid job: it warns that flash-related targets follow the same policy as pio_upload, including stop_open_sessions and port-diagnosis rules, signaling potential side effects and prerequisites. It does not fully spell out the policy, but the explicit pointer to pio_upload gives the agent actionable context about the tool's operational behavior.

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 two sentences with no filler: the first sentence states the core action and valid inputs, and the second conveys the important policy inheritance for flash-related targets. Every word contributes to selection or invocation guidance.

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 five parameters, no annotations, and zero schema description coverage, the description covers the most critical operational nuance—flash-related targets inherit pio_upload's policy—but leaves env, project_dir, and upload_port semantics to be inferred. The presence of an output schema helps, but the tool could still benefit from a bit more guidance on parameter usage and non-flash targets.

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 adds meaningful semantics to the 'target' parameter with concrete examples and ties 'stop_open_sessions' and 'upload_port' to port-diagnosis rules. However, 'env' and 'project_dir' receive no explanation, and the description does not clarify how the parameters interact, leaving part of the parameters under-specified.

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 opens with a specific verb and resource: 'Run one named target from pio_list_targets', immediately distinguishing the tool as a generic target runner. Concrete examples ('buildfs', 'uploadfs', 'erase', 'size') clarify the expected input, and referencing pio_upload only for policy rather than as the action keeps the purpose unambiguous.

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 clearly tells the agent when to use this tool—whenever a named target needs to be executed—and points to pio_list_targets as the source of valid target names. It also gives usage context for flash-related targets by inheriting the policy, stop_open_sessions, and port-diagnosis rules of pio_upload. However, it does not explicitly say when not to use it or name an alternative tool for other scenarios.

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