pause_flow

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false) the description discloses real behavior: the flow stops, open sessions are cancelled, a linked comment trigger is paused, and a flow.paused event fires. That is unusually rich. The one tension is that cancelling open sessions reads as a destructive side effect while destructiveHint=false; not a flat contradiction, but worth noting.

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?

Five short sentences, front-loaded with the action, then effects, then the event, then the call convention. No filler, and the unusual "Send {} as the body" detail is placed at the end where it is easy to scan.

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 one-parameter mutation with no output schema, the description covers the important unknowns: what stops, what gets cancelled, what else is affected, and what event is emitted. It stops short of stating reversibility (i.e. that activate_flow resumes it) or preconditions on the flow's state.

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?

With a single parameter at 100% schema description coverage, the schema already carries the parameter meaning. The description's only addition is the invocation hint "Send {} as the body," which clarifies body handling but says nothing about what the required id refers to or what a valid id looks like.

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?

"Pause a flow" gives a specific verb and resource, and the following sentences sharpen it with side effects (open sessions cancelled, linked comment trigger paused). It is clearly distinguishable from delete_flow or update_flow, but it never explicitly names the counterpart (activate_flow) or states how it differs from deletion.

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?

Usage is only implied: the disclosure that sessions are cancelled signals this is a consequential state change, so an agent can infer pause-vs-delete tradeoffs. There is no explicit when-to-use, when-not-to-use, or prerequisite (e.g. whether the flow must be active/published first) guidance.

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