pause_sync
Pause a sync. Existing events are untouched; no new propagation occurs until resumed. Idempotent — pausing an already-paused sync is a no-op.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| syncId | Yes |
Pause a sync. Existing events are untouched; no new propagation occurs until resumed. Idempotent — pausing an already-paused sync is a no-op.
| Name | Required | Description | Default |
|---|---|---|---|
| syncId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes far beyond basic read/write flags provided by annotations. It details crucial operational constraints: 'Existing events are untouched; no new propagation occurs until resumed,' which informs the agent about the scope of the pause.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The definition is extremely concise. It front-loads the core purpose and uses the remaining sentences efficiently to explain the operational guarantees (untouched events, idempotency).
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple schema, the description is comprehensive. It addresses the primary behavioral concerns (mutability, state preservation, idempotency) necessary for an AI agent to execute the tool safely and correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema coverage, the description must compensate for the lack of detail regarding the 'syncId' parameter. However, the description focuses entirely on the *action* and not on the meaning or constraints of the input parameter, resulting in a baseline adequate score.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a precise verb and resource ('Pause a sync'), which clearly distinguishes it from related tools like 'get_sync' (read) or 'resume_sync' (opposite action). The purpose is immediately clear.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly defines the tool's behavior relative to its state by stating, 'Idempotent — pausing an already-paused sync is a no-op.' This provides strong guidance on when calling the tool repeatedly is safe.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.