pyocd_svd_attach_builtin

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

The description warns that built-in SVDs are 'generic/simplified versions' and may lack peripheral definitions, and notes that the SVD is extracted to a temp directory. However, it does not mention cleanup of temp files or potential conflicts with existing attachments, which would improve transparency.

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 a concise three-sentence paragraph with a clear structure: purpose, limitation warning, recommendation, and technical detail. Every sentence is necessary, and there is no redundancy.

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 that an output schema exists (so return values need no explanation), the description fully covers what the tool does, when to use it, its limitations, and how it relates to the sibling tool. It provides sufficient context for an agent to make an informed decision.

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 100%, so the baseline is 3. The description adds value by providing example SVD filenames and advising to use pyocd_project_load to discover available names, giving practical usage context beyond the 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 tool's purpose: 'Attach a built-in SVD from pyocd's bundled svd_data.zip as a TEMPORARY fallback.' It distinguishes from the sibling tool pyocd_svd_attach by emphasizing that this is a fallback for when no vendor SVD is available.

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 explicitly advises when to use this tool ('last resort when no vendor SVD is available') and strongly recommends the alternative pyocd_svd_attach, providing clear 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.