pyocd_svd_attach

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

No annotations are provided, so the description carries full burden. It does not disclose what happens if the file path is invalid, whether it replaces an existing attachment, or if a session is required. Minimal behavioral context beyond the action.

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 with no waste. The first sentence states the action and purpose; the second provides essential context about SVD files. Well-structured and 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 the simplicity of the tool (one parameter) and the presence of an output schema, the description is mostly complete. It explains the purpose and file type but could mention that this is a prerequisite for other SVD operations. Still 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 100% for the single parameter 'svd_path'. The description adds value by explaining what SVD files are (register layout of MCU peripherals) and providing examples (GPIO, UART, SPI), which goes beyond the schema's 'Absolute path to the SVD file'.

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 verb 'Attach' and the resource 'SVD file'. It distinguishes from the sibling 'pyocd_svd_attach_builtin' by specifying it attaches a file, not a built-in. The examples of peripherals (GPIO, UART, SPI) add context.

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 explicit guidance on when to use this tool versus alternatives like 'pyocd_svd_attach_builtin'. The description only states the basic action; an agent would need to infer use cases from the tool name and context.

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