confluence_update_page

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It only says 'Updates a page' and mentions versionNumber; it does not explain that content is replaced, that a stale versionNumber may cause failure, or any authentication/error behavior.

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 short and front-loaded with the core action. The versionNumber note is useful but somewhat redundant with the schema's required field list.

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?

With 8 parameters, no annotations, no output schema, and low schema coverage, the description is far from complete. It omits guidance on body format, required parameter roles, version handling, and failure behavior, leaving the agent to infer too much.

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 only 13%, so the description should compensate by explaining key parameters. It does not explain bodyValue, title, status, spaceId, bodyRepresentation, or versionMessage; the only mention, that versionNumber is required, merely repeats schema information.

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 updates a Confluence page and identifies the underlying HTTP method. It distinguishes the operation from creation at a basic level, though it does not explicitly contrast with confluence_create_page or other siblings.

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?

Use is implied for updating existing Confluence pages, and the note that versionNumber is required provides an important precondition. However, there is no explicit guidance on when to choose this over confluence_create_page or how to obtain the correct versionNumber.

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