appflowy_update_page

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

No annotations provided, so description must stand alone. It indicates mutation ('Update') but does not disclose side effects, permissions, reversibility, or whether unmentioned fields are preserved. Fails to provide sufficient behavioral context for a mutation tool.

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?

One sentence, concise but under-specified. Front-loaded with verb, but brevity sacrifices completeness for a tool with nested parameters.

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 and 3 required params (with nested objects), the description omits key context: required IDs, partial update semantics, and return value. Incomplete for correct invocation.

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 0%; description lists some request fields (name, icon, lock state, extra metadata) but does not explain required params (workspace_id, page_id) or the structure of icon/extra. Adds partial meaning but misses critical details.

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 verb 'Update' and the resource 'a page', listing specific attributes (name, icon, lock state, extra metadata). It distinguishes from sibling tools like create_page and get_page by focusing on modification.

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?

No guidance on when to use this tool versus alternatives like appflowy_create_page or appflowy_move_page_to_trash. Lacks context for prerequisites or exclusions.

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