Get Page Version Diff

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

The readOnlyHint annotation already covers the safety profile. The description adds the 'unified diff' format detail, which is a behavioral trait, but does not disclose additional traits such as version ordering direction, pagination, or error behavior. With annotations present, this is adequate but not rich.

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, well-formed sentence with zero redundant words. It front-loads the core action and resource with no filler, earning its place completely.

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 simple read-only tool with three fully documented parameters and an output schema, the description is nearly complete. The only minor gap is that it doesn't explicitly clarify the direction of the diff (from from_version to to_version), but the schema field names and descriptions largely convey this.

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%, so the schema already documents all three parameters (page_id, from_version, to_version). The description adds no parameter-level meaning beyond what the schema provides, hence 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 states a specific verb ('Get') and a clearly defined resource ('a unified diff between two versions of a Confluence page'). This distinguishes it from all sibling tools, none of which claim to produce diffs between versions.

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 clear usage context: the agent should select this tool when it needs to compare two versions of a Confluence page. It doesn't explicitly name alternatives or exclusions, but the context is straightforward given the tool name and sibling list.

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