yuque_list_docs

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

No annotations are provided, so the description carries the burden. It discloses the HTTP verb/path, the sort order, and a cap of 100 items, which is genuine behavioral context, but it says nothing about whether the repository must be accessible, whether the call is read-only and non-destructive (implied by 'List' but not stated), or how trimmed vs raw output behaves.

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?

Compact and front-loaded: operation, sort, constraint, endpoint, then a pointer to further docs. Nothing is redundant, though the terse '/repos/:id/docs' and Chinese-language reference are slightly opaque to an English-reading agent.

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 read-only list tool with no annotations and no output schema, the description covers the essentials (scope, sort, cap) but omits return-shape hints, pagination interplay between offset and limit, and differentiation from sibling list tools. Adequate but with clear gaps.

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 description coverage is 100%, so the baseline is 3; every parameter (raw, limit, offset, book_id, optional_properties) is already documented in the schema. The description's only parameter note, 'limit ≤ 100', merely repeats the schema's 'max 100'.

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?

States a specific verb (List) and resource (documents in a repo) plus the sort order (updated_at desc), so the operation is unambiguous. It does not differentiate from near-duplicate siblings such as yuque_web_list_docs or yuque_batch_get_docs, which prevents a 5.

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 when-to-use guidance and no mention of alternatives, despite several sibling list tools (yuque_web_list_docs, yuque_batch_get_docs, yuque_list_notes) that an agent could confuse it with. The endpoint path and reference file are provided but not a selection criterion.

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