Skip to main content
Glama

Pause batch

pause_batch
Destructive

Pause a sending or scheduled batch.

Input Schema

NameRequiredDescriptionDefault
idYesBatch id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false, so the description's main added fact is that both 'sending' and 'scheduled' batches are valid targets. It says nothing about what happens to in-flight messages, whether the pause is reversible via resume_batch, or whether repeating the call is safe — gaps that matter for a non-idempotent destructive mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One front-loaded sentence with zero filler. It is efficient, though the brevity reflects omitted content rather than tight editing of rich content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, non-idempotent state-change tool with no output schema, the description should say what a successful pause does to pending recipients and whether it can be undone. Neither is covered, leaving the agent to guess at consequences before invoking.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is a single parameter with 100% schema description coverage, so the schema already documents 'id' as the batch id. The description adds no format, prefix, or lookup hints beyond that, which is the expected baseline when the schema carries the semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Pause) and resource (batch) plus a state qualifier ('sending or scheduled'), which tells the agent the operation applies to in-flight and queued batches. It does not distinguish itself from the closely related siblings resume_batch, cancel_batch, and retry_batch.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to pause versus cancel or retry a batch, and no mention of prerequisites or what state the batch must be in. The agent must infer the choice from the sibling names alone.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources