yuque_create_doc

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

With no annotations, the description carries the full burden of behavioral disclosure. It only says 'Create a new Yuque doc' — this implies it creates rather than updates, but does not mention permissions, duplicate slug behavior, response format, or whether the 'public' field controls visibility. This minimal disclosure is insufficient for a mutation tool.

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 with no fluff, but it is under-specified rather than appropriately sized. It does not waste words, but it also does not provide enough information to be considered well-structured for the agent's needs.

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?

With six parameters, no annotations, and no output schema, the description is far too incomplete. It provides no information about return values, side effects, or distinctions from similar create tools, leaving the agent to infer critical usage details from the schema and sibling tool names.

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 does not compensate by explaining any of the six parameters. It adds no meaning beyond the input schema, whose property names are self-explanatory but still lack context such as the meaning of 'namespace' or the 'public' enum.

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 uses a specific verb and resource ('Create a new Yuque doc') and is clearly understood. However, it does not distinguish this from sibling tools like yuque_create_document_with_toc or yuque_create_doc_from_file, which also create Yuque docs.

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 versus alternatives. With siblings like yuque_create_document_with_toc and yuque_create_doc_from_file, the description should indicate which scenario this base create tool is for, but it does not.

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