yuque_get_repo

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

With no annotations, the description carries the burden, but as a read-only GET it is implicitly safe. It does disclose a non-obvious behavior: that toc_yml (a YAML TOC tree) is embedded in the response, and that fields are trimmed unless raw is set. It omits auth requirements and any rate-limit/pagination behavior.

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: the resource, key return fields, HTTP route, and a reference pointer come in a few dense fragments with no filler. The trailing Chinese doc reference is useful rather than wasteful.

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?

There is no output schema and no annotations, so the description must cover return shape — and it does name the key fields (toc_yml, namespace, items_count, full metadata). It also points at an API reference for deeper detail, leaving only minor gaps like auth requirements.

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 both params (raw, book_id) are already documented in the schema, including the namespace-or-ID format for book_id. The description adds nothing parameter-specific beyond the schema, so the baseline 3 applies.

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 and resource ('Get repo detail') and enumerates the notable returned fields (toc_yml, namespace, items_count, full metadata). It is distinguishable from list_repos/batch_get_repos/update_repo, though it does not explicitly differentiate from yuque_get_toc despite both surfacing TOC data.

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 on when to use this versus alternatives such as yuque_get_toc (which also returns TOC data), yuque_list_repos, or yuque_batch_get_repos. Usage is only implied by the 'Get' verb; no exclusions or prerequisites are stated.

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