clickup_doc_edit_page

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

No annotations are provided, so the description fully bears the transparency burden. It explains how content modes work, that names can be changed or kept, and that IDs come from other listed tools. It lacks detail on auth or rate limits, but for an edit operation the described behavior is 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?

Four concise sentences, each serving a purpose: state primary action, explain modes, offer alternative tool, and indicate return value. No fluff, front-loaded with the most important information first.

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 output schema, the description still mentions 'Returns the updated page object.' It covers all major behavioral aspects, parameter sourcing, and mode variations. For a 6-param tool with 2 required, this is fully comprehensive.

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?

All 6 parameters have 100% schema description coverage. The description adds context beyond the schema by noting default behaviors (e.g., 'Omit to leave content unchanged', 'Omit to keep current title', 'Omit to use default workspace') and sourcing hints. This enriches the 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?

Description clearly states the tool renames or rewrites existing pages in ClickUp docs, differentiating from clickup_doc_add_page for new pages. The verb 'rename' and 'rewrite' plus resource 'existing page' make purpose specific.

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?

Description explains default replace behavior and mode options (append/prepend), and explicitly guides users to use clickup_doc_add_page for fresh pages. This provides clear when-to and when-not-to guidance.

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