read_serial

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

With no annotations provided, the description carries the full behavioral burden. It states the tool is read-only, does not make PASS/FAIL judgments, and has a critical timing constraint for boot log capture. It also explains the exact kind of output returned, which is strong, non-redundant behavioral disclosure beyond the schema.

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 compact, front-loaded with the core function and return type, then providing essential warnings and timing instructions. Every sentence earns its place; there is no filler or repetition of schema data.

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 no output schema, the description sufficiently explains what the agent can expect (raw text and objective stats) and the tool's limitations (no PASS/FAIL verdicts). It also provides critical workflow context — call immediately after flash for boot logs — making this complete for an agent to invoke correctly.

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 100%, so all four parameters are already documented with their meanings (port auto-detection, board enum, duration range with default, project_dir default). The description does not add extra parameter-specific detail beyond the schema, so the baseline 3 is appropriate.

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, specific action — read serial output — and describes the return content (raw text plus objective statistics: empty, crash keyword hits, reset count). It is clearly distinguishable from sibling tools like flash, erase_flash, compile, and status, since it is the only one focused on reading serial data.

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 gives explicit context on when to use the tool: it is read-only and freely callable, and it emphasizes that boot logs must be captured immediately after a successful flash. It does not explicitly name sibling alternatives or state when not to use it, but the timing guidance and read-only note provide clear contextual usage.

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