Skip to main content
Glama

trigger_sync

Manually trigger a sync run. Returns immediately with a job ID or a structured reason if gated (backoff, coalescing, rate limit). Does not wait for the run to complete.

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": {
      "syncId": "<syncId>"
    },
    "name": "trigger_sync"
  }
}

Input Schema

NameRequiredDescriptionDefault
syncIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=false and destructiveHint=false; the description adds genuinely new behavioral facts: it returns immediately, returns a job ID, can be gated with structured reasons (backoff, coalescing, rate limit), and does not block for completion. This is exactly the async/gating context an agent needs and cannot get from annotations.

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 sentences, zero filler, front-loaded with the core action followed by return semantics and the non-blocking caveat. Every sentence earns its place.

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 one-parameter mutation with no output schema, the description covers async semantics and gating reasons well. It stops short of stating how to follow up (e.g., poll via get_sync_run) or any permission prerequisites, so it is strong but not exhaustive.

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 0%, so the description carries the burden, and it says nothing about syncId. The parameter is largely self-evident from its name and the schema supplies uuid format/pattern, so the gap is mild rather than severe, but no added semantics are provided.

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?

The description states a specific verb and resource: 'Manually trigger a sync run.' This distinguishes it from config-oriented siblings like create_sync and state-control siblings like pause_sync/resume_sync. However, it never explicitly names an alternative, so an agent must infer the boundary 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?

The word 'manually' implies usage in contrast to a scheduled/automatic run, giving implied context. But there is no explicit when-to-use, when-not, or named alternative (e.g., use list_sync_runs or get_sync_run to observe results), leaving routing to inference.

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