compare_picklists

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

No annotations are provided, so the description carries the full burden. It describes what the tool detects (missing values, label differences) but does not disclose side effects, authentication requirements, or whether it is read-only. The behavioral disclosure is partial.

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 three sentences, front-loaded with the core purpose, and includes additional details about what it detects. It is appropriately sized but could be structured to better highlight usage and parameters.

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 tool's complexity (7 parameters, optional auth, output schema exists), the description omits prerequisites, network access needs, and authentication context. However, the output schema relieves the need to explain return values. Overall, moderately complete.

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 43% (required only). The description adds no parameter-specific details, leaving optional parameters (user/password) unexplained. With low coverage, the description fails to compensate.

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 it compares picklist values between two Salesforce instances, specifying what it detects (missing values, label differences). The verb 'compare' is precise and distinguishes it from sibling tools like 'get_picklist_values' (single instance) and other compare tools via the 'picklist' resource.

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 provides usage context ('critical during migrations') but lacks explicit when-not scenarios or alternatives. With many compare siblings, explicit guidance would help, but the migration hint gives some direction.

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