Skip to main content
Glama

pause_program_enrollment

Pause one client's program: nothing more goes out until it is resumed. (confirm-gated: previews until confirm: true)

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": {
      "id": "<id>"
    },
    "name": "pause_program_enrollment"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
confirmNoMust be true to actually execute. If false/omitted, returns a preview only.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

Adds real behavior beyond the lone readOnlyHint=false: pausing halts all outgoing activity, the state is reversible, and the call is confirm-gated so an unconfirmed call returns only a preview. It does not say what the preview contains or what happens to already-scheduled items, so it is not fully transparent.

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?

Two compact clauses with the core effect front-loaded and the confirm-gating caveat immediately after. No filler.

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

Completeness4/5

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

For a two-parameter mutation with no output schema, the description covers effect, reversibility, and the preview/confirm protocol adequately. The main remaining gap is disambiguating what `id` refers to, which matters for invoking it correctly.

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?

The parenthetical clarifies that confirm:true is needed to execute, but that is largely repeated from the schema property description. The required `id` is undocumented in both schema and description, and 'one client's program' leaves it unclear whether id is an enrollment id, program id, or client id.

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?

Specific verb ('Pause') plus resource ('program enrollment') scoped to one client, which separates it from cancel_program_enrollment and resume_program_enrollment by implication. It stops short of naming those siblings explicitly, so the agent must infer the pause/cancel distinction itself.

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

Usage Guidelines3/5

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

'nothing more goes out until it is resumed' implies when the tool is appropriate and points at the resume path, but there is no explicit when-to-use vs cancel/archive guidance and no stated prerequisites or exclusions.

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.