appflowy_search_summary

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

Describes the two-step process (search then summarize) and notes that each summary lists source object_ids. With no annotations provided, this adds useful behavioral context, but lacks details on potential costs or limitations.

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 concise sentences front-load the purpose and clarify the process. Every word adds value; no redundancy.

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 4 parameters with no schema descriptions, no output schema, and no annotations, the description is insufficient for correct tool use. It lacks explanations of parameter behavior and return format beyond vague source object_ids.

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 has 0% description coverage and the description adds no specific parameter info. It does not explain workspace_id, query, limit, or only_context, leaving the agent without critical usage 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 it searches the workspace and returns an AI-generated cited summary, distinguishing it from sibling tools like appflowy_search that likely perform plain search without summarization.

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?

Implicitly suggests use when a summarized answer with citations is needed, but provides no explicit guidance on when to use this versus alternatives like appflowy_search, nor any exclusions.

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