yuque_update_resource

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

No annotations are provided, so the description must carry the full burden. It discloses that resource_type is limited to 'board' and that text and dsl are mutually exclusive, but it does not mention side effects, permissions required, idempotency, or what happens to existing data. The description is adequate but not comprehensive.

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 two sentences, front-loaded with the action and resource. Every sentence is concise and contains essential information with no redundancy.

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 6 parameters, no output schema, and no annotations, the description covers the basic operation but lacks details on return values, error conditions, or prerequisites. It adequately describes the input constraints but is incomplete for a full understanding of the tool's behavior.

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 each parameter having a description. The description adds the mutual exclusivity rule ('provide exactly one of text or dsl') which is already implied by the schema descriptions, and restates the resource_type enum limitation. The added value over the schema is minimal, earning a baseline score of 3.

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' and the resource type 'structured resource in a Yuque document'. It mentions the current limitation to 'board' and the mutually exclusive 'text' and 'dsl' fields, making the purpose distinct from sibling tools like yuque_update_doc. However, it does not explicitly differentiate from all siblings.

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 provides a rule for selecting between text and dsl ('provide exactly one'), but it gives no guidance on when to use this tool versus alternatives such as yuque_update_doc or yuque_update_book. Usage context is implied but not explicit.

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