Update a Docmost page

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

No annotations are provided, so the description carries the full burden. It does communicate that the body can be overwritten (a destructive behavior) and that title/icon are optional modifications, but it says nothing about permissions, reversibility, versioning of overwritten content, or failure modes. The operation semantics it implies largely duplicate the schema enum.

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?

A single compact sentence that front-loads the primary action (body modification) and tacks on secondary capabilities. Efficient, with only mild redundancy against the schema's operation enumeration.

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 5-parameter mutation tool with no annotations and no output schema, the description covers the main capabilities adequately but omits auth/permission requirements, confirmation of what is returned, and any warning about losing existing content on replace. It is minimally sufficient rather than complete.

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 100%, so every parameter is already documented in the schema, including pageId accepting slug/URL, the operation enum, and the ability to omit markdown. The description adds no format or constraint detail beyond that baseline.

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?

Names a specific verb set (replaces, appends, prepends) and resource (page body), plus ancillary actions (rename, change icon). It is clearly an update tool and distinct from create_page/get_page by its mutating framing, though it never names a sibling explicitly.

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 says what can be changed but never states when to use this tool versus create_page or get_page, nor any prerequisites such as needing an existing pageId. Usage is only implied by the word 'update'.

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