Skip to main content
Glama

Pause tenant

pause_tenant
DestructiveIdempotent

Pause a tenant: its new sends are refused until it is resumed. The rest of the account keeps sending. Confirm with the user first.

Input Schema

NameRequiredDescriptionDefault
reasonNoWhy it is paused (shown on the tenant)
tenantYesThe tenant to pause. The tenant's external id (your id for that customer) or its Groundmail id

Output Schema

NameRequiredDescriptionDefault
tenantYesThe tenant

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, and the description goes further by describing blast radius: only the tenant's new sends are refused, the rest of the account keeps sending. It also implies reversibility ('until it is resumed'), which is exactly the context an agent needs before a destructive call.

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?

Three short clauses, front-loaded with the action and its effect, then the scoping reassurance, then the confirmation directive. Every sentence earns its place with no 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?

An output schema exists, so return values need not be explained. Given a destructive, idempotent mutation, the description covers effect scope, reversibility, and the human-confirmation requirement — everything needed to invoke it safely.

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?

Schema description coverage is 100%, and the schema already explains both 'tenant' (external id or Groundmail id) and 'reason' (shown on the tenant). The description adds no meaning beyond that, so the baseline 3 applies.

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 (pause), resource (tenant), and the precise effect scope: new sends are refused while the rest of the account keeps sending. An agent can distinguish this from resume_tenant and from account-level actions without opening any schema.

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 a concrete invocation prerequisite — 'Confirm with the user first' — which is guidance an agent would otherwise lack for a destructive tool. It does not explicitly route to siblings like resume_tenant or update_tenant, so it falls short of full when/when-not/alternatives coverage.

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