read_rtt

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

With no annotations provided, the description carries the full burden. It describes a read operation ('读取') which is inherently non-destructive, but does not explicitly state safety, prerequisites, or side effects. The return format is mentioned, but details like rate limits or error behavior are absent.

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 structured with Args and Returns sections, which aids readability, but includes verbose phrasing (e.g., '从目标 MCU 读取'). It could be more concise while retaining all necessary information.

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 tool has only two parameters and an output schema exists (though not shown), the description sufficiently covers the core functionality and return format. Minor gaps exist (e.g., behavior when max_size is exceeded), but overall it provides enough context for an agent to use the tool 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?

The description adds semantic meaning beyond the input schema: it explains that channels default to read all (0-15) and that max_size has a default of 4096 bytes. This compensates for the schema lacking descriptions. However, it does not detail edge cases like invalid channel values.

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 clearly states the tool reads RTT log data from a target MCU, using specific verbs ('读取') and resource ('RTT日志数据'). While it doesn't explicitly differentiate from siblings, the purpose is distinct and unambiguous given sibling names like write_rtt and set_rtt_channel.

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 provided on when to use this tool versus alternatives such as write_rtt or set_rtt_channel. The description implies use for reading logs but does not specify scenarios or exclusions.

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