Create Group Iteration Cadence

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

Annotations already declare it is a non-read-only, non-idempotent, non-destructive open-world mutation, so the safety bar is lower. The description adds genuine beyond-schema context: that automatic cadences derive iterations from start_date/duration_in_advance fields while manual cadences produce no scheduled iterations, and that the feature is gated to Premium/Ultimate tiers — a real precondition an agent would otherwise not know.

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?

Two short sentences, front-loaded with the action and followed by the mode distinction and tier note. No filler, no repetition of the title, every clause carries information.

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?

For a 9-parameter mutation with no output schema and zero schema descriptions, the definition covers the most consequential behavior (mode semantics and tier gating). It is thin on the remaining fields, notably roll_over, whose effect is not obvious from its name alone, but nothing needed to understand the tool's purpose is missing.

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% across 9 parameters, so the description carries the burden and only partially meets it: it explains start_date, duration_in_weeks, and iterations_in_advance and their dependency on automatic=true. It says nothing about roll_over, active, title, group_id, or the description field, so a caller must infer several parameters purely from type and name.

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 first sentence gives a specific verb plus resource ('Create an iteration cadence'), which is unambiguous and clearly distinct from the sibling update/delete cadence tools. It does not explicitly name a sibling to differentiate against, so it stops short of a 5.

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 explains the automatic vs. manual mode distinction, which implicitly tells the caller which parameter set applies, and notes the Premium/Ultimate prerequisite. However, it never says when to choose this tool over gitlab_create_group_iteration (creating an individual iteration) or when to prefer updating an existing cadence, leaving the key routing decision to inference.

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