appflowy_list_quick_notes

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

No annotations are provided, so the description bears the burden. It discloses optional search and pagination, but does not detail behavior like default ordering, whether results are sorted, or if there are any side effects. Basic but adequate for a simple listing.

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 13-word sentence covering all key aspects: listing quick notes, workspace scoping, optional search and pagination. No wasted words, front-loaded with the core action.

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?

The tool has no output schema, so the description should describe what is returned. However, it only says 'List quick notes' without specifying the output fields or format. This is a significant gap for a listing tool.

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 description coverage is 0%, so the description must add meaning. It mentions 'optional search and pagination', which hints at search_term, limit, offset, but does not explain each parameter's purpose or format. workspace_id is required but not described. Minimal additional value over 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?

The description clearly states 'List quick notes in a workspace', specifying the action (list), resource (quick notes), and scope (in a workspace). It distinguishes from siblings like appflowy_list_workspaces and appflowy_list_trash.

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?

The description implies when to use: when you need to list quick notes in a workspace. However, it does not provide explicit guidance on when not to use it or alternatives like appflowy_search for broader search.

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