yuque_get_doc_versions

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

Discloses permission requirement ('权限要求: read'), which is helpful given no annotations. However, no details on return format, ordering, pagination, or whether full content is included. With no annotations, more behavioral context would be beneficial.

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?

Short and structured with bullet points for parameters and permission. Front-loaded purpose. Could be more concise by removing redundant '参数:' label, but overall 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?

With a single parameter and an existing output schema (unseen), the description covers permission but lacks guidance on when to list vs single version, and no mention of list properties like ordering or limits. Adequate for a simple list tool but not complete.

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?

Description explains 'doc_id' is a document ID, adding minimal meaning beyond the schema (which has 0% coverage). For a simple string parameter, this is adequate but insufficient to fully compensate for the coverage gap.

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 '获取文档历史版本列表' (get document version list), specifying verb 'get' and resource 'document versions'. This distinguishes from sibling 'yuque_get_doc_version' which retrieves a single version, making the purpose unambiguous.

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 needing a list of versions, but lacks explicit when-to-use vs alternatives like 'yuque_get_doc_version'. No guidance on prerequisites or context.

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