Pause or unpause a pipeline

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

Annotations declare readOnlyHint=false and destructiveHint=false, so the safety profile is covered structurally. The description adds genuinely useful behavioral context beyond that: exactly what a paused state suppresses (schedules, sensors, trigger events, start_pipeline calls), confirming pausing is non-destructive and reversible. It omits any note on permissions or the effect on already-running runs.

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 tight sentences: the action and identifier first, then the behavioral consequence. No filler and everything front-loaded.

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?

An output schema exists, so return values need not be described, and the effect of pausing is well covered. The main gap is that the bidirectional behavior of the `paused` flag is left for the agent to infer from the parameter name.

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 67% and the schema already documents pipeline_id_or_alias and the account-id header. The description restates the alias/ID acceptance but adds no format or validation detail, and never explains the `paused` boolean semantics (true=pause, false=unpause). Baseline 3 is 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?

States a specific verb pair (pause/unpause) and resource (pipeline) and the identifier it accepts. It is clearly distinguishable from siblings like start_pipeline or cancel_pipeline_run, which involve different operations on the same resource.

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 implies when this operation is relevant by explaining what pausing does, but it gives no explicit when-to-use guidance, no exclusions, and does not name alternatives (e.g., cancel_pipeline_run for stopping in-flight runs). Usage must be inferred.

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