yuque_get_repository_overview

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

No annotations are provided, so the description must carry the full burden. It makes the read-only nature and combined output clear, but does not disclose return format, potential errors, or any authentication requirements. The 'one call' efficiency hint adds some behavioral context beyond the tool name.

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 sentence of eight words, front-loaded with the action and outcome. Every word earns its place, and there is no repetition of the tool name.

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 one-parameter, no-output-schema endpoint, the description is minimally adequate: it states the tool gets repository details and TOC. However, 'details' is vague, and the lack of output schema and parameter guidance leaves room for ambiguity about the exact return payload and namespace format.

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 0%, and the description never mentions the 'namespace' parameter or how to construct it. The tool name hints at repository context, but the description adds no meaning beyond the raw schema field name. Since the schema is minimal, the description should compensate but does not.

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 specifies verb 'Get' and resource 'repository details and TOC in one call'. This clearly distinguishes it from siblings like yuque_get_repo and yuque_get_repo_toc, which fetch the same data separately.

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?

'In one call' implies this tool is the combined alternative to calling yuque_get_repo and yuque_get_repo_toc separately. It gives clear context for when to use it, though it doesn't explicitly name the alternatives or state when not to use it.

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