dbgprobe.mem.read

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It does not explicitly state that the operation is non-destructive or whether it affects target state. However, 'read' implies safety, and the SVD decoding note adds useful context.

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, each providing essential information. No redundancy. The key verb ('Read') and resources are front-loaded.

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 no output schema, the description adequately explains return data and special SVD behavior. It does not cover error conditions (e.g., invalid address), but for a debug read tool, this is sufficient.

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 75%, and the description adds value beyond the schema by explaining default format ('hex'), the meaning of each format option, and the condition for SVD field decoding. It clarifies how the format parameter affects output.

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 'Read memory from the target', specifies return formats ('hex', 'base64', 'u32'), and mentions special SVD behavior. This distinguishes it from siblings like dbgprobe.svd.read (structured register reads) and dbgprobe.rtt.read (RTT reads).

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 provides clear context for raw memory reads versus SVD-based reads, but does not explicitly state when not to use it or name alternatives. The purpose is clear enough for an agent to infer usage.

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