serial_read

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

With no annotations, the description carries the full behavioral burden. It usefully discloses the ~64KB cap to protect context, a non-obvious trait that directly affects agent call planning. It does not cover blocking behavior, buffer drain, or return format, but the disclosed cap is significant.

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 sentences, front-loaded with the action and resource, immediately explains the context-protecting cap. No wasted words; every sentence earns its place.

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 the simple two-parameter read operation and no output schema, the description provides enough for correct calling: the buffer concept and context protection are communicated. Could be enhanced by clarifying empty-buffer handling and whether read drains remaining data, but not mandatory for a typical agent call.

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 coverage is 100% and both parameters (encoding and maxBytes) are already documented with descriptions, defaults, and bounds. The description adds no additional parameter semantics, but the schema fully covers the needed context.

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 ('Read') with a specific resource ('buffered bytes from the open serial port') and an important constraint (buffer cap). It distinguishes this from siblings like serial_write and serial_status without requiring schema inspection.

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?

It implies 'when open, read after write' but does not explicitly say when to use this over serial_status or other read-like alternatives. No mention of conditions like empty buffer or expected interactions, so the agent must infer the read flow from context.

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