gitee_update_check_run

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

No annotations are supplied, and the description fails to disclose any behavioral traits beyond the generic 'update'. Mutation side effects, permission requirements, or state transitions (e.g., status changes) are entirely omitted.

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 extremely concise at one sentence, but this brevity sacrifices clarity and completeness. It could be restructured to front-load key details while remaining succinct.

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 annotations, no output schema, and an 11-parameter schema with enums and optional fields, the description is severely incomplete. It fails to explain check run lifecycle, status transitions, or when to use this tool effectively.

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 inline descriptions for all 11 parameters, so the schema does the heavy lifting. The description adds no additional meaning, making the baseline score of 3 appropriate.

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 a check run' is essentially a tautology of the tool name 'gitee_update_check_run'. It provides no differentiation from sibling tools like gitee_create_check_run or gitee_get_check_run, leaving the scope and specific action vague.

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. The description lacks context about prerequisites, appropriate scenarios, or exclusions, leaving the agent without decision-making support.

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