pyocd_register_write

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

With no annotations, the description carries full burden for behavioral disclosure. It does not mention side effects (e.g., requires a connected session, may cause undefined behavior if CPU is running) or whether the write takes effect immediately or after a resume.

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 single-sentence description is concise and front-loaded, but it may be too minimal—missing important context that could be added without significant length increase.

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?

Despite having an output schema, the description is incomplete for a potentially dangerous operation like register write. It lacks safety warnings, connection requirements, and explanation of when writes are allowed (e.g., only when target is halted).

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% (both parameters documented), so baseline is 3. The description adds no extra meaning beyond the schema; it doesn't clarify valid register names (e.g., 'r0', 'sp', 'pc') or value constraints.

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 'Write a value to a CPU core register' clearly states the verb (write) and resource (CPU core register), distinguishing it from sibling tools like pyocd_register_read and pyocd_register_read_all.

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 (e.g., pyocd_memory_write for memory, or pyocd_svd_write for SVD registers). There is no mention of prerequisites like target must be halted.

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