yuque_get_toc

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

The description states it requires 'read' permission, but beyond that, no behavioral traits are disclosed. Without annotations, the description should cover aspects like idempotency, side effects, or return structure; it does not.

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 concise: a one-line purpose followed by permission and a parameter list. It is front-loaded with the purpose. Every sentence adds value, though the parameter list could be integrated into a more narrative structure.

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 an output schema exists, the description does not need to detail return values. However, it lacks information about pagination, sorting, or behavior when the toc is large. For a simple retrieval tool, it is minimally adequate but not comprehensive.

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?

Although the schema description coverage is 0%, the description adds Chinese explanations for each parameter ('团队/用户 login' and '知识库 slug'), providing semantic meaning that the schema (with only English titles) lacks. This compensates for the lack of schema descriptions.

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 states '获取知识库目录' (get repository table of contents), which clearly indicates the tool's function. However, it does not differentiate from sibling tools like yuque_get_toc_by_book_id, which likely serves a similar purpose.

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 is provided on when to use this tool over alternatives. While it mentions a permission requirement, it lacks context on prerequisites or typical use cases, leaving the agent to infer usage.

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