compare_bom_to_design

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

No annotations are provided, and the description only states that a comparison is performed. It does not disclose whether the operation is read-only, what happens for mismatches, what the output contains, or any side effects. The RefDes matching detail adds a bit of behavioral context but is insufficient.

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?

A single front-loaded sentence that immediately states the action and scope. It contains no filler or redundant repetition of the tool name, making it concise 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 that the tool involves a nested external_records structure and an optional path, the description is too sparse. It doesn't clarify the role of path, the expected shape of external records beyond 'typed', or how matching discrepancies are reported. The output schema reduces some burden, but the tool's context is still incomplete.

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?

The description adds meaning to external_records by calling them 'typed external BOM rows' and mentions RefDes as the join key, but it does not explain the optional path parameter at all. With schema description coverage at 0%, the description should carry more weight but leaves parameter semantics largely to 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 uses a specific verb ('Compare') and identifies both operand types ('typed external BOM rows' and 'normalized design records') plus the matching key ('by RefDes'). This clearly distinguishes it from BOM-related siblings like get_bom or review_bom.

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 is given about when to use this tool versus alternatives. It does not mention exclusions, prerequisites, or related tools such as compare_schematic_to_pcb or validate_mpn_consistency, leaving usage context entirely implicit.

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