pyocd_svd_update_fields

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

Describes the atomic read-modify-write behavior and accepts both integer and enum name values. With no annotations, the description adequately conveys the operation, though it could mention required permissions or error conditions.

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?

Three sentences: purpose, parameter format, example. No superfluous content. Efficient and well-structured.

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 complexity (multi-field atomic update), the description is sufficiently complete with purpose, input format, and an example. Context signals show output schema exists, so return values are covered elsewhere.

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?

Adds meaning beyond schema by explaining the dict format and providing an example. Schema already covers each parameter, but the description clarifies usage with enum strings.

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?

Clearly states it sets multiple bit fields of a register atomically via a read-modify-write. Distinguishes from sibling tools like pyocd_svd_set_field (single field) and pyocd_register_write (direct write) by emphasizing atomic multi-field update.

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?

Provides an example implying usage but does not explicitly state when to use this tool over alternatives or give exclusion criteria. No guidance on when not to use it.

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