Skip to main content
Glama

pause_rule

Idempotent

Stop a reply rule immediately so it halts preparing or sending replies when it behaves unexpectedly. Requires only the rule ID; already-paused rules stay unchanged.

Instructions

Pause a reply rule at once, with no approval.

A paused rule stops preparing or sending replies until the user resumes
it. Pausing only reduces what GigaMail does on its own, so it needs no
approval; resuming does (resume_rule). Use it when a rule is doing
something unexpected and the user wants it to stop now. Idempotent: a
rule already paused stays as it is, with its reason. Returns {success:
true, state: 'paused'}, and raises an error for a rule that does not
exist. The pause is recorded in the audit log and the user is told.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "rule_id": "<rule_id>"
    },
    "name": "pause_rule"
  }
}

Input Schema

NameRequiredDescriptionDefault
rule_idYesRule id exactly as returned by list_rules (for example 'rule_1a2b3c4d').

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.6.8

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the annotations (idempotentHint, destructiveHint=false), the description discloses an approval/asymmetry model, audit-log recording, user notification, and the error condition for a nonexistent rule. It even elaborates idempotency beyond the hint by noting a paused rule keeps its reason. The only missing piece is what happens to in-flight replies already prepared.

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?

Front-loads the action in the first clause and then layers effect, approval rationale, when-to-use, idempotency, and return shape in a readable order. Slightly verbose in places ("at once", restating the user twice) but nearly every sentence carries information.

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

Completeness5/5

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

For a single-parameter mutation with no output schema, the description supplies the return shape, the failure mode, and the side effects (audit log, user notification). Nothing an agent needs in order to call it correctly is missing.

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?

With one parameter at 100% schema coverage, the schema already explains rule_id with an example. The description adds no further meaning about the identifier, so the baseline 3 applies rather than a 4 or 5.

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

Purpose5/5

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

States a specific verb and resource ("Pause a reply rule") and immediately scopes the effect: a paused rule stops preparing or sending replies. It also distinguishes itself from the sibling resume_rule, so an agent can choose between them without opening a schema.

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

Usage Guidelines5/5

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

Gives an explicit trigger ("when a rule is doing something unexpected and the user wants it to stop now") and an explicit alternative with its condition (resuming requires approval, via resume_rule). It also frames the no-approval rule structurally rather than as a special case.

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