Skip to main content
Glama

Pause, resume, or retire a keyword

keyword_manage
DestructiveIdempotent

Manage a keyword's lifecycle across every Source at once: pause stops all its polling and all its spending, resume restarts it, delete retires it and frees the plan slot. Free — does not charge credits. Pausing is also how you stop the polling that does. On resume, a Source an operator stopped stays stopped and comes back named in blockedSources rather than failing the call: read that field before reporting success. delete takes an optional purge: without it the mentions the keyword caught stay readable, with purge=true they are deleted too and cannot be recovered. Ask before pausing or deleting, and ask again before purging: this is the customer's monitoring and the mentions are the record of what it found.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesKeyword id, from list_keywords. Another account's id is a 404, never a 403.
purgeNoOnly with action=delete. true also deletes every mention the keyword collected, with its readings, marks and replay entries. The keyword itself stays readable by id. Omitted or false is the default retire: the mentions stay readable until retention ages them out. This erases the customer's collected data and is not reversible, so ask before sending it. Credits are not refunded either way.
actionYespause stops every Source: nothing polls, charges or delivers, and the mentions already caught stay readable. resume restarts every Source that can follow. delete retires the keyword and frees the plan slot; it is not a hard delete, so the keyword and its mentions stay readable.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already signal destructive/non-read-only behavior, and the description adds substantial context: the operation is free, paused sources stopped by an operator remain stopped on resume and surface in blockedSources, purge is irreversible, and customer consent is required. No contradiction with annotations.

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?

The description is dense and mostly front-loaded, with the scope and actions in the first sentence. A few clauses are slightly awkward, but every sentence contributes operational value.

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 3-parameter mutation with no output schema, this is thorough: it covers credit effects, return behavior via blockedSources, retention vs purge, irreversibility, and consultation requirements. Nothing an agent needs to invoke it correctly is missing.

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 100% and both action and purge are already well documented. The description adds extra meaning by explaining the blockedSources return field and reinforcing the irreversible data-loss implications of purge=true, which goes beyond the schema.

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 ('manage'), a resource ('keyword'), and the scope ('across every Source at once'), then enumerates the three distinct lifecycle actions: pause, resume, delete. This differentiates it clearly from per-source tools like keyword_source_manage.

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?

Defines when each action applies and gives explicit operational guidance: pause stops polling/spending, resume restarts, delete retires and frees a slot. It also instructs the agent to ask before pausing, deleting, or purging. It does not explicitly name sibling alternatives, but the 'across every Source at once' framing makes the intended scope clear.

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