yuque_update_note

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

No annotations are given, and the description provides no behavioral details. For a mutation tool, critical information such as whether the update is partial or full, what happens if the note_id does not exist, or authentication requirements is entirely missing.

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 only one sentence, which is concise, but it sacrifices necessary detail. It is not optimally structured as it front-loads only a generic action without context.

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 no output schema and no annotations, the description is incomplete. It does not explain what the tool returns, nor does it specify behavioral aspects like idempotency or error handling. For a simple mutation with 2 parameters, this is insufficient.

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 coverage is 100% with parameter descriptions for note_id and body. The description 'Update an existing note' adds no additional meaning beyond the schema. Baseline of 3 is appropriate since schema already documents parameters.

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 'Update an existing note' provides a clear verb+resource combination, indicating what the tool does. However, with siblings like yuque_update_doc and yuque_update_book, it does not differentiate what makes a 'note' distinct, but the resource name itself serves as differentiation.

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 usage guidelines are provided. The description does not indicate when to use this tool versus the many sibling update tools, nor does it mention any prerequisites or conditions for use.

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