metadata_diff

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

With no annotations, the description carries the full burden. It mentions 'Pro feature' and the scope of comparison (fields and locales), but does not explicitly note that the tool is read-only, whether a pending version must already exist, or how errors are handled. This is adequate but not detailed.

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 two sentences, front-loaded with the primary purpose ('Compare metadata') followed by specifics on what changes are shown. There is no filler or repetition of schema details.

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 tool with one parameter and no output schema, the description gives a solid understanding of its purpose and what the output will contain (changes in descriptions, keywords, and release notes across locales). It could be more explicit about prerequisites (like an existing pending version) or the exact output format, but overall it is reasonably 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 100% for the single parameter app_id, which is already described as 'App Store Connect app ID'. The description adds no additional meaning to the parameter, so the baseline of 3 is appropriate.

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 tool's function with a specific verb ('Compare') and resource ('metadata between your live and pending app versions'), and further specifies what fields are compared (descriptions, keywords, release notes) across locales. This distinguishes it from sibling tools like update_version_metadata (which writes) and release_notes (which simply shows notes).

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 implies the tool is used to review changes before updating metadata, which provides clear context. However, it does not explicitly state when to use it versus alternatives or exclude other tools. The 'Pro feature' note adds access context but no 'when-not-to-use' guidance.

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