appflowy_favorite_page

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It only lists actions without explaining side effects, error conditions, or idempotency. Key traits like whether the page must exist or if operations are reversible are omitted.

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, front-loaded sentence. While concise, it is under-specified for the tool's complexity (3 parameters, nested object). It wastes no words but fails to earn its place with substantive detail.

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 3 parameters with a nested object, no output schema, and no description coverage, the description is incomplete. It does not explain how the tool behaves (e.g., what happens on success/failure, whether it returns anything, how multiple operations are handled).

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%, meaning no parameter descriptions exist in the schema. The description adds no semantic meaning to the parameters (workspace_id, page_id, request) beyond what the schema structure shows. The boolean fields is_favorite and is_pinned are left entirely unexplained.

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 tool allows favoriting, unfavoriting, pinning, or unpinning a page. It uses specific verbs and identifies the resource ('a page'), making the purpose unambiguous. It also distinguishes from sibling tools like appflowy_list_favorites and appflowy_update_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?

The description provides no guidance on when to use this tool versus alternatives like appflowy_list_favorites (to check favorites) or appflowy_update_page (to modify page content). There are no context cues about prerequisites or caveats.

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