compare_environment_forms

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

Annotations already declare readOnlyHint=true and the description is fully consistent, explicitly reinforcing 'No writes'. It adds real context beyond the annotations: the comparison is positional XML rather than semantic, and it does not constitute publication verification. Missing are edge behavior (form not found, differing form IDs) and any sense of the result shape.

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 tight sentences, zero filler, with the core action stated first and the negative scope ('no writes') immediately after. Every clause earns its place.

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?

For a six-parameter, five-required tool with no output schema and near-zero schema documentation, the description is thin. It omits the distinction between logical_name and the two form ID parameters and gives no indication of what a comparison returns, leaving the agent to guess at correct invocation.

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 only 17%, so the description carries most of the burden, yet it only alludes to source_profile/target_profile. It never explains what logical_name adds over source_form_id/target_form_id, nor how the optional environment_profile coexists with two explicitly named profiles.

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 pairs a specific verb with a specific resource: read saved main forms from two named environment profiles and compare positional XML. That distinguishes it from sibling inspect/prepare tools and from compare_solution_snapshots. It stops short of 5 because 'positional XML' comparison is not spelled out enough to know what asymmetry it detects.

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?

It implies the trigger condition (cross-profile form comparison, requiring two explicitly named profiles) and rules out verification use with 'No writes or publication verification'. However, it never names an alternative such as review_form_three_way or compare_solution_snapshots, so the agent must infer which compare tool to pick.

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