yuque_read

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

Description indicates a read operation returning content, but does not explicitly state read-only nature, access requirements, or potential side effects. Given no annotations, description carries full burden; it is adequate but not detailed.

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, no unnecessary words. Every sentence adds value: action, method, and return type. Highly efficient.

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?

For a simple read tool with one parameter and no output schema, the description adequately covers what it does and returns. Could mention error cases or format, but minimal gaps for this low complexity.

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?

Parameter schema has 100% coverage with a clear description. The tool description merely restates the parameter usage ('by URL') without adding new meaning beyond what the schema provides. Baseline score of 3 is appropriate.

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 verb ('Read') and resource ('Yuque document') and specifies return type ('full rendered content'). Differentiates from siblings by focusing on rendered content vs markdown (yuque_read_markdown) or listing (yuque_list_docs).

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?

Description implies when to use: when you have a document URL and want the full rendered content. Does not explicitly state when not to use or mention alternatives, but context of sibling tools provides some guidance.

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