yuque_create_document_with_toc

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

With no annotations, the description carries the full burden but only states the basic action. It does not disclose atomicity, side effects, required TOC existence, failure modes, or any mutation risks. The description is too minimal to provide meaningful behavioral transparency.

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 clear sentence, efficiently conveying the core purpose without wasted words. It is appropriately front-loaded, though it could have included more details without sacrificing conciseness.

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 7 parameters, no annotations, and no output schema, the description is vastly incomplete. It neither explains the TOC attachment semantics nor provides context for parameter values or operational expectations, making it inadequate for reliable 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?

Schema description coverage is 0%, and the description provides no explanation for any of the 7 parameters. It does not add meaning to properties like public, parent_uuid, namespace, or format, leaving the agent without sufficient guidance to set them correctly.

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 explicitly states the tool creates a document and attaches it to TOC in one call, using specific verbs and resources. It clearly distinguishes from sibling tools like yuque_create_doc and yuque_update_toc by clarifying the combined action.

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 implies usage for combined create-and-attach operations but does not explicitly state when to prefer this over separate calls, nor does it mention alternatives or exclusions. The context is inferred rather than clearly communicated.

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