compare_profiles

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 discloses that when file_path and include_preview are provided, the tool 'renders both profiles as inline images for visual comparison'. This is a key behavioral trait beyond what the input schema conveys.

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 very concise: three main sentences plus a parameter list. Every sentence adds value, and the core purpose is front-loaded. No unnecessary words.

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 absence of annotations and output schema, the description covers the main purpose, usage context, and the preview feature. It does not explicitly describe the output format (textual diff? images?), but the mention of 'show the differences' and 'renders as inline images' provides sufficient expectation for an agent.

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?

With 0% schema description coverage, the description must compensate. It lists all five parameters and explains the role of file_path and include_preview in enabling visual preview. However, the required parameters profile_a and profile_b lack details on their format (e.g., file path vs. profile ID), leaving ambiguity.

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 action ('compare two PP3 profiles and show the differences') and the resource ('PP3 profiles'). It provides specific use cases ('before choosing between them' or 'to see what changed after adjustments'), which distinguishes it from sibling tools like adjust_profile or read_profile.

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 gives explicit context for when to use the tool: 'before choosing between them' or 'to see what changed after adjustments'. It does not explicitly state when not to use it or mention alternatives, but the guidance is clear and helpful.

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