Skip to main content
Glama
viftode4
by viftode4

get_sync_status

Read-onlyIdempotent

Check a background sync job's state, coverage, errors, and resumption offset to identify issues or resume processing.

Instructions

Get a background sync job's state, coverage, errors and resumption offset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
jobIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already carry the safety profile (readOnlyHint, idempotentHint, openWorldHint, destructiveHint=all covering the read/benign nature), so the burden is lowered. The description adds value by listing what the status reports (state, coverage, errors, resumption offset) but offers no detail on edge behavior such as a missing job ID or the meaning of the state values. No contradiction with 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?

A single sentence that front-loads the action and resource ('Get a background sync job's state') and compresses the return areas into a short list. Every word earns its place; there is no preamble, fluff, or repetition.

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 single-parameter, read-only status tool with a strict UUID schema and no nested objects, the description is close to complete. Since there is no output schema, naming the four return areas (state, coverage, errors, resumption offset) is helpful, though it stops short of defining the state values or the channel for error/coverage semantics. Overall adequate for the simplicity level.

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%, but the single parameter jobId is self-explanatory and fully constrained by the schema's type, format, and pattern. The description ties the parameter to the resource ('a background sync job'), disambiguating what ID to pass. It adds just enough context for correct invocation but nothing beyond that.

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 uses a specific verb ('get') plus a specific resource ('background sync job') and lists the exact data returned (state, coverage, errors, resumption offset). This makes it clearly distinct from the login, mail, and content siblings, though it does not explicitly disambiguate from the closely related get_index_status.

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

Usage Guidelines2/5

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

There is no guidance about when to call this tool versus alternatives. An agent gets no instruction on the polling pattern with start_course_sync (the tool that presumably creates these jobs) or on how to choose between get_sync_status and the similarly named get_index_status. The only sense of usage is trivially inferable from the tool's name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.