confluence_edit_page

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

Discloses that edits are local to the cache until pushed, and explains the replace_all parameter. However, it does not mention permissions, atomically, or what happens if the page isn't cached, which would improve transparency.

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 efficiently structured: a brief summary, then a clear workflow instruction, followed by parameter explanations in bullet form. No unnecessary fluff.

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?

Covers the workflow and parameter details well, but lacks information about return values or side effects (e.g., nothing returned). Since no output schema exists, a brief note on output would improve completeness.

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?

With 0% schema description coverage, the description fully explains each parameter: page_id, find, replace, and replace_all. It clarifies the boolean's behavior (first vs. all occurrences), adding meaning beyond the 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 'Find and replace text in a cached Confluence page.' The verb-resource pair is specific, and the tool is distinguished from siblings like confluence_find_replace by emphasizing local cache operation.

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?

Explicitly outlines the intended workflow: call confluence_get_page first, then edit, then confluence_push_page. This tells the agent exactly when and how to use this tool in sequence.

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