yuque_search

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

Mentions permission requirement ('read'), but lacks disclosure of side effects, pagination behavior, or result limits. With no annotations, description should carry more weight.

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?

Reasonably concise bullet list format with front-loaded purpose and permission. Could be more structured but no extraneous content.

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?

Covers purpose and parameters; output schema exists for return values. Lacks usage context, error handling, or limitations, but adequate for a search tool with sibling 'get' tools.

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 description adds meaning for all parameters: 'q' as search keyword, 'type' with examples (doc/repo/user), and brief explanations for scope, page, offset. Provides value beyond schema but not exhaustive.

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?

Description clearly states 'perform a general search in Yuque' with a specific verb and resource. It inherently distinguishes from sibling 'get' tools which retrieve specific entities by ID.

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 explicit guidance on when to use this tool vs alternatives. Implicit from name, but no conditional or exclusionary statements provided.

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