confluence_find_replace

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

No annotations provided, so description carries full burden. It explains the combined operation, scope of replacement (text nodes only), and mentions it modifies pages. Could add more on permissions or error handling, but sufficient.

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?

Concise, well-structured: one-line summary, brief behavior note, then bullet-point Args. No redundant sentences; 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?

Covers parameter semantics and high-level behavior, but lacks description of return value format or error scenarios (e.g., page not found, text not found). Given no output schema, more detail 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?

Schema coverage 0%, but description adds detailed parameter docs: page_id accepts numeric ID or URL, replace_all default true, version_message optional. Each parameter gets meaningful context beyond the schema's titles.

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 'find and replace' on a Confluence page, explicitly says it combines get+edit+push into one step, distinguishing it from sibling tools like confluence_get_page, confluence_edit_page, and confluence_push_page.

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?

Provides clear context: only replaces within text content nodes, not structural ADF elements. This guides when to use, but lacks explicit exclusions or comparison with alternatives like confluence_regex_replace.

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