Get Page Version Diff

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

The description is consistent with the 'readOnlyHint' annotation, indicating a read operation. However, it does not add behavioral context beyond stating it returns a 'JSON string with page info and unified diff'—no mention of permissions, rate limits, or error conditions.

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 highly concise: one sentence for purpose, a formatted Args list, and a Returns line. Every sentence serves a clear purpose with no wasted words, and the structure is front-loaded with the core action.

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 presence of an output schema and comprehensive parameter descriptions, the description adequately explains the tool's functionality and output format. Minor gaps exist (e.g., no mention that both versions must exist), but overall it is sufficient for a simple diff tool.

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?

The input schema already provides detailed descriptions for all three parameters (100% coverage), including an example for page_id. The description's parameter list adds no new meaning beyond restating the parameter names, so it meets the baseline but does not enhance semantics.

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 'get a unified diff between two versions of a Confluence page', using a specific verb and resource. This distinguishes it from sibling tools like 'confluence_get_page' (which retrieves full page content) and 'confluence_get_page_history' (which lists version history).

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 for comparing page versions, but provides no explicit guidance on when to use it versus alternatives (e.g., 'use this for diffs, use confluence_get_page for full content'). No exclusions or when-not-to-use scenarios are mentioned.

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