List Serial Ports

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

Annotations already communicate that this is read-only, and the description adds relevant context about the arduino-cli dependency and platform support. It also sets expectations that board metadata is only included when detected, but does not describe failure modes or environment requirements beyond the OS list.

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?

Two short sentences deliver the core purpose, implementation dependency, and platform scope with no filler. The resource is front-loaded and every clause adds value.

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 tool with an output schema, the description is mostly complete: it names the resource, the implementation, and supported platforms. It would be stronger with an explicit note on when to prefer it over list_connected_boards.

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?

There are zero parameters and schema coverage is 100%, so there is no parameter documentation burden on the description. The description correctly says nothing about parameters.

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 states a clear verb ('List') and resource ('serial ports') and adds 'detected board metadata' to define scope. It is distinguishable from close siblings like list_connected_boards because the resource is explicitly 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?

No guidance is given on when to choose this tool over related tools such as list_connected_boards, detect_hardware, or read_serial_snapshot. The platform note ('Works on Windows/macOS/Linux') is useful but does not explain when to use this tool versus alternatives.

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