get_sync
Get details of a single sync including last 5 run summaries and any recent error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| syncId | Yes |
Get details of a single sync including last 5 run summaries and any recent error.
| 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?
Annotations declare readOnlyHint=true, so safety is covered, but the description adds genuinely useful behavior: the exact payload shape (last 5 run summaries plus any recent error), which is the only place this is documented since no output schema exists. It still omits what happens when the syncId does not exist or is not accessible.
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?
One sentence, front-loaded with the core action, and every clause (run summaries, recent error) earns its place by telling the agent what it will receive. No filler or restatement of the tool name.
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?
For a one-parameter read-only getter with no output schema, the description adequately covers the return contents. The remaining gap is not telling the agent where syncIds come from (list_syncs) or what a missing ID returns, which is minor but real.
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?
Schema description coverage is 0%, but the single parameter is the self-explanatory syncId and the schema enforces a strict UUID format and pattern, so callers cannot easily misuse it. The description adds no meaning beyond the schema, so this sits at the baseline rather than above it.
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?
States a specific verb (get) and resource (a single sync), and goes further by naming what the response contains: last 5 run summaries and any recent error. It is clearly distinguishable from list_syncs and get_sync_run, though it never explicitly contrasts itself with get_sync_health, which also targets one sync.
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?
No when-to-use guidance, no prerequisites, and no named alternatives. The agent must infer from the name alone that this is the by-ID lookup versus list_syncs for enumeration or get_sync_health for status. There is no help routing between these near-siblings.
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.