yuque_list_docs

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

With no annotations, the description must fully disclose behavior but only says 'List all documents'. It omits critical details like pagination behavior, sorting, limits, or whether the response includes all fields or a summary. This leaves the agent guessing about performance and output structure.

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, efficient sentence that directly communicates the tool's action. No redundant words or phrases.

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 list tool with one parameter and no output schema, the description is minimally adequate. However, it lacks clarity on what 'documents' includes, whether pagination exists, and how results are sorted. Given sibling tools for notes and books, more context would help.

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 100% with one parameter already described as 'Repo ID or namespace'. The description does not add new semantic context beyond restating the tool's purpose. Baseline score of 3 is appropriate since the schema fully documents the parameter.

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 lists documents in a repo/book using a specific verb and resource. However, it does not differentiate from sibling list tools like yuque_list_books or yuque_list_notes, which could confuse the agent about what constitutes a 'document' versus a 'note' or 'book'.

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 guidance is provided on when to use this tool versus alternatives like yuque_list_notes or yuque_search. The agent receives no information about prerequisites, exclusions, or context where this tool is preferred.

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