micropython_read_stream

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

With no annotations provided, the description carries the full burden and does add real behavioral context: duration caps the read, idle_timeout triggers early termination on inactivity, and exceeding max_bytes yields truncated=True. It doesn't state permissions or blocking behavior, but the timeout/truncation semantics are genuinely disclosed.

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?

Structured Args/Returns layout is front-loaded with the action sentence first, and each entry earns its place. The Returns block partly duplicates the output schema, but it still conveys useful semantics efficiently.

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?

Parameters are fully explained and the output fields are described, which is more than sufficient given an output schema exists. The only real omission is context on how this read tool relates to its numerous siblings.

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, and it does: all three parameters are explained (duration=max seconds, idle_timeout=early-exit threshold, max_bytes=truncation limit) with the observable consequence of max_bytes spelled out. This meaningfully exceeds the bare schema.

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 specific verb+resource: reading stream output from the connected device for a bounded time. This is clear, but it never distinguishes itself from the many read-oriented siblings (micropython_read_until, micropython_read_lines, micropython_read_file, micropython_exec), so an agent cannot tell which read tool applies without opening schemas.

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?

There is no when-to-use guidance and no exclusions. Given ~10 sibling read tools, the definition gives no signal for choosing read_stream over read_until or read_lines, leaving selection entirely to inference.

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