yuque_get_repo_toc

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

No annotations are present, and the description provides no behavioral details beyond the verb 'get'. It does not mention read-only status, error handling, pagination, or return format, placing the full burden on the description, which it fails to meet.

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 concise sentence with no fluff, which is efficient. However, it verges on under-specification, a tautological restatement of the tool name with only 'entries' added as detail.

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?

Given no annotations, no output schema, and 0% parameter description coverage, the description is severely lacking. It does not explain what TOC entries are, how the namespace should be formatted, or what response to expect, making it insufficient for correct tool invocation.

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?

The single parameter 'namespace' has no description in the schema (0% coverage) and is not explained in the tool description. While the name suggests the repo namespace, the description adds no additional semantics, leaving the agent to infer format or required meaning.

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 the action (Get) and resource (repo TOC entries), making the tool's purpose understandable. However, it does not differentiate from sibling tools like yuque_list_docs or yuque_get_repo, lacking any specificity about the structure or use case.

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?

There is no guidance on when to choose this tool over alternatives such as yuque_list_docs or yuque_update_toc. The description only restates the function, leaving the agent without context for selection.

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