Confluence Update Page

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

With no annotations, the description carries the burden. It discloses that the body replaces the whole page (overwrite risk), that versioning is handled automatically, and that the updated page is re-read and returned. It does not cover permissions or error conditions, but the key mutation behavior is clearly stated.

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 concise, with the core action and versioning in the first sentence, and a crucial warning about overwriting in the second. No fluff, every sentence adds value.

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 no annotations, the description covers the essential behavior: overwrite risk, versioning, and return value. It lacks explicit permission requirements and error handling, but for a mutation tool this is reasonably complete. The main gap is the unexplained message parameter.

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 0%, so the description must compensate. It explains body (markdown) and title, but the message parameter (likely a version comment) is not mentioned. page_id is obvious from the tool name. Partial coverage, but not fully compensates for the schema gap.

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 action (update) and the resource (a page's body and/or title), and it distinguishes from siblings like create and get by mentioning versioning and the overwrite behavior. It is specific and unambiguous.

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?

It explicitly instructs to read the page first with confluence_get_page if the user wants to edit rather than overwrite, providing clear conditional guidance. This effectively tells when to use this tool vs. reading first, and implies when overwriting is acceptable.

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