yuque_get_toc_by_book_id

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

No annotations are provided, so the description carries the full burden. It only states it's a read operation with permission requirement. It does not disclose behavioral traits like error handling, data limits, or the structure of the returned directory. This is insufficient for a tool with no annotations.

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 very short and front-loaded with the purpose. However, it is not concise in a helpful way; it omits necessary details. The structure with '权限要求:' and '参数:' is clear, but the content is too minimal to be effective.

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 the tool has an output schema, the description does not need to explain return values. However, it still lacks completeness: it does not mention the scope of the directory (e.g., full tree or flat list), depth, or any filtering. For a tool that returns a TOC, the description is insufficiently detailed.

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 only repeats the parameter name ('book_id: 知识库 ID') without adding any meaning beyond the schema. It does not explain what a knowledge base ID is, how to obtain it, its format, or any constraints. This fails to compensate for the missing 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 clearly states '通过知识库 ID 获取目录' (get directory by knowledge base ID). This is a specific verb+resource, and it distinguishes from sibling tools like yuque_get_toc (which might not take a book_id) and yuque_get_doc (which gets a document, not a directory).

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?

The description mentions '权限要求: read', indicating it's a read operation, but it does not provide any guidance on when to use this tool versus alternatives, such as yuque_get_toc or other get tools. No context about prerequisites or use cases is given.

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