appflowy_update_quick_note

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

The description indicates that content is replaced (not appended) and mentions two input formats, but it does not disclose behavioral traits like precedence of data over text, destructive nature, required permissions, or error handling. Since no annotations are provided, the description carries the full burden and is somewhat lacking.

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 a single concise sentence that front-loads the action and key details. There is no wasted text.

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 tool with no output schema and minimal annotations, the description provides the core functionality but lacks details about return values, error cases, or the structure of raw data. It is adequate but not completely informative.

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?

The description adds meaning for the 'text' and 'data' parameters within the request object, explaining that text is converted to paragraph blocks and data takes precedence. However, the top-level required parameters (workspace_id, quick_note_id) have no schema descriptions and are not explained in the description, so the overall parameter semantics is only partially covered.

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 action ('replace a quick note's content') and the resource ('quick note'), and distinguishes it from sibling tools like 'appflowy_create_quick_note' and 'appflowy_delete_quick_note'. It also specifies the two input formats (plain text or raw block data).

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 is provided on when to use this tool versus alternatives such as 'appflowy_update_page' or when to choose plain text over raw data. There are no explicit when-to-use or when-not-to-use indications.

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