read_peripheral_register

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

Without annotations, the description must fully disclose behavior. It mentions decoding bitfields and the need for a halted target, but does not describe error behavior, return format, or what happens if the register name is invalid. This is adequate for a simple read tool but leaves gaps.

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 extremely concise: two sentences, no filler. The first sentence explains the primary function with examples, the second adds a crucial prerequisite. Every sentence 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?

Given the presence of an output schema, the description appropriately omits return details. It includes the prerequisite of halting the target and hints at the decoded output (named bitfields). Missing aspects like error cases or timeouts are minor for such a focused tool.

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 compensates by explaining the 'name' parameter format with examples ('RCC.CR', 'GPIOA.MODER') and the fact it is a register name. This adds significant meaning beyond 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 clearly states the action (read), resource (peripheral register by name), and additional behavior (decode named bitfields). It provides concrete examples ('RCC.CR', 'GPIOA.MODER') and distinguishes from sibling tools like 'read_register' and 'read_peripheral' by specifying the decoding and naming convention.

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 includes a clear prerequisite: 'The target should be halted for a stable read.' It implies the tool is for reading decoded peripheral registers, but does not explicitly list when to avoid this tool or mention alternatives like 'list_peripheral_registers' or 'read_register'.

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