stm32_list_serial_ports

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

With no annotations provided, the description carries the burden. It implies a non-destructive read operation through the word 'Lists,' but it does not explicitly state that it performs no system changes, whether it requires any permissions, or what happens when no ports are found. Basic behavior is conveyed, but richer safety/limitation context is missing.

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?

A single, focused sentence with no filler or redundant wording. It states the action, resource, scope, and a content detail about the output. Every part contributes to understanding what the tool does.

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?

For a zero-parameter read-only enumeration tool with an output schema present, the description sufficiently covers the necessary purpose. It could go further to note the distribution between serial ports and debug probes, but this is a minor omission; the definition is essentially complete for its simplicity.

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?

The tool has zero parameters and the input schema is an empty object, so there is no parameter burden. The baseline of 4 applies; there is nothing to explain beyond the fact that no arguments are needed, which the empty schema already shows.

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 ('Lists') with a specific resource ('all available UART / COM serial ports on the host system') and adds that hardware descriptions are included. This clearly distinguishes the tool from sibling tools like stm32_list_connected_probes, which targets debug probes rather than serial ports.

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 context of 'on the host system' implies the tool is for enumerating local UART/COM ports, but it does not explicitly mention when to prefer this over stm32_list_connected_probes, nor does it say what to use it for (e.g., before read_serial/write_serial). Usage is implied rather than explicit.

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