confluence_compare_versions

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

Describes the internal process (fetch ADF, extract plaintext, produce diff) and input flexibility (page ID or URL). With no annotations, it carries the full burden and could disclose more about permissions or error handling.

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?

Extremely concise: two sentences plus a structured Args block. Front-loaded with purpose. No redundancy or irrelevant information.

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 low complexity (3 params, no output schema), the description is fairly complete. It explains the tool's function, parameters, and process. Could mention return format or error behavior, but not essential.

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 coverage is 0%, so description must compensate. The Args section adds meaning: explains that page_id accepts numeric ID or URL, and defines version_a as 'before' and version_b as 'after'. Adds value beyond bare schema.

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?

Clearly states verb and resource: 'Compare two versions of a Confluence page'. Distinguishes from siblings like confluencelist_versions (lists versions) and confluencenextract_text (extracts single version). The title 'confluence_compare_versions' is well-explained.

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?

Implies usage for comparing specific versions, but does not explicitly state when to use vs alternatives or when not to use. However, the process description clarifies its purpose. Lacks exclusion guidance.

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