diff_models

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

No annotations are provided, so the description carries the burden. The verb 'Diff' reasonably implies a read-only comparison rather than a mutation, and the accepted input kinds are stated. However, it does not explicitly disclose whether inputs are modified, what access is required, or how the comparison behaves when inputs are incompatible.

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 single front-loaded sentence with no filler. Every word adds value, especially the parenthetical that constrains the accepted input types. This is appropriately concise for a relatively simple tool.

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?

The description is minimally viable for the main use case: an agent can infer that before and after are the two things to compare. The output schema covers return values, so not describing them is acceptable. However, the tool lacks usage guidance and leaves the optional inspector parameter undocumented, making the overall context 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?

Schema description coverage is 0%, so the description must compensate. It does clarify that 'before' and 'after' refer to two semantic models in PBIP folder or snapshot form, which is useful. But the optional 'inspector' parameter is left completely unexplained, and no format or syntax details for the string values are provided.

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 a specific verb and resource: 'Diff two semantic models.' The parenthetical '(PBIP folders or snapshots)' sharpens the input scope and helps the tool stand apart from deployment/refresh/reporting siblings. It doesn't explicitly contrast with any sibling, but no other sibling is a compare-style operation.

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?

There is no guidance on when to prefer this tool over alternatives, such as using it before plan_change or apply_plan. The description merely states what the tool does, leaving intended usage context and exclusions to inference.

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