Skip to main content
Glama

Pause or resume a monitor

pause_monitor
Idempotent

Pause a monitor so it makes no more scheduled runs, or resume it. Use it when the person wants a kept search or question to stop for now, or to start again. A paused monitor keeps its runs and records; nothing is deleted. Inputs: monitor_id from list_monitors. resume=true starts it again: a slot that passed while it was paused runs once, at the next tick. Effect: it answers with the monitor. A run under way finishes. Nothing is fetched and no credits are spent by pausing. Needs write access; a read-only connection is refused with code 'read_only'.

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": {
      "monitor_id": "<monitor_id>"
    },
    "name": "pause_monitor"
  }
}

Input Schema

NameRequiredDescriptionDefault
resumeNotrue resumes a paused monitor; default false pauses it.
monitor_idYesThe monitor's id, from list_monitors or create_monitor.

Output Schema

NameRequiredDescriptionDefault
idNoThe monitor's id, for list_monitors, pause_monitor and get_monitor_rows.
codeNoOnly on a failure: a machine-readable reason, e.g. read_only, validation, plan_limit or not_found.
kindNo'search' or 'agent'.
nameNoIts name; the query or the prompt unless one was given.
noteNoWhat happens next, or what was left out.
rowsNoWhen it follows its answer as records: {path, key, confirmAfter}.
errorNoOnly when the call failed: what went wrong, in words an assistant can act on.
budgetNo{perRun, perMonth} in credits; 0 is no cap.
detailNoOnly on a failure: the API's own wording, when the error was rephrased.
statusNo'active' or 'paused'. On an error, the HTTP status code.
lastRunNoIts latest run: {status, changed, summary, credits, refId}; refId is the search or agent run it made.
requestNoThe search or agent request it runs, in the API's names.
scheduleNo'hourly', 'daily' or 'weekly'.
nextRunAtNoWhen it runs next, ISO 8601; null while paused.
spentThisMonthNoWhat its runs cost this calendar month (UTC), in credits.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior5/5

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

Adds substantial behavior beyond annotations: paused monitors keep runs and records, in-progress runs finish, pausing fetches nothing and spends no credits, and resume triggers one catch-up run for a missed slot. It also states the write-access requirement and the 'read_only' refusal code.

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

Conciseness5/5

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

Front-loads the core action, then uses labeled sections for inputs, effect, and access requirements. Every sentence adds useful information, and nothing is redundant filler.

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?

Covers the key behavioral, access, and side-effect details an agent needs for a mutation tool, while relying on the output schema for return-value specifics. The catch-up resume behavior and in-progress run handling make it complete for invocation.

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

Parameters4/5

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

Schema coverage is already 100%, so baseline is 3, but the description adds meaningful resume semantics: a slot that passed while paused runs once at the next tick. The monitor_id source is mostly repeated from the schema, keeping this from a 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: pausing or resuming a monitor so scheduled runs stop or start. The phrase 'makes no more scheduled runs' precisely distinguishes the operation from listing, creating, or running monitors.

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

Usage Guidelines4/5

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

Gives clear context for use: when the person wants a kept search or question to stop temporarily or start again. It does not explicitly name an alternative tool or when-not-to-use condition, but the intended situation is unambiguous.

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.