appflowy_get_collab

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

With no annotations, the description carries full burden. It discloses that the tool reads collab storage directly, bypasses the lazy page-view path, and can recover pages. It implicitly indicates a read operation, though it does not explicitly state read-only or mention any side effects. It does not discuss permissions, rate limits, or response structure beyond Markdown.

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?

Two sentences with no waste. The first sentence states the core purpose and output format, and the second adds valuable context about when to use it. Every word earns its place.

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?

While the description explains the unique capability and use case, it lacks details on return format (aside from Markdown), error handling, and parameter semantics. Given the tool interacts with internal collab storage and has no output schema or annotations, more completeness would be helpful.

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%, and the description does not explain any parameters by name or provide meaning beyond their existence. It mentions workspace_id and page_id implicitly (they are required) but fails to describe the optional ‘title’ parameter or the expected format. The description should compensate for low schema coverage but does not.

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 retrieves document content as Markdown via the ‘raw collab endpoint’, with a specific verb and resource. It distinguishes itself from siblings by explaining it bypasses the lazy page-view path and can recover pages that other tools fail on.

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 explicitly states when to use this tool: when appflowy_get_page or export report ‘Collab not found’ or return empty. This provides clear guidance on when to prefer this tool over alternatives.

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