yuque_update_doc

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

With no annotations, the description carries the full burden of disclosing side effects, permissions, and update semantics. It only reveals that the tool updates an existing doc and accepts slug/doc_id as identifiers, but does not explain whether updates are partial or full, what happens if both identifiers are provided, or what the response looks like.

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 front-loaded sentence with no fluff, making it efficient. However, it is somewhat under-specified for an 8-parameter tool, but that sacrifice is acceptable for 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?

The description is severely incomplete given the tool's complexity. There is no output schema, no annotations, and the description only covers the basic action, leaving update semantics, field interactions, and return behavior entirely unspecified.

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 description adds minimal meaning to the parameters by indicating that slug or doc_id are identifier alternatives. However, it doesn't clarify the roles of body, title, format, public, new_slug, or namespace, leaving 8 parameters with 0% schema coverage largely unexplained.

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 ('Update'), the resource ('Yuque doc'), and the identifier method ('by slug or doc_id'). This distinguishes it from sibling tools like create_doc, delete_doc, and get_doc, though it doesn't explicitly mention the updatable fields (title, body, etc.), which are left to the schema.

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 use this tool versus alternatives like update_doc_from_file, nor any mention of prerequisites or exclusions. The description is purely a functional statement without contextual cue.

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