Skip to main content
Glama

sync_status

Read-onlyIdempotent

Check a background synchronization job to see if course assignments, PDFs, and feedback synced completely, and report partial failures or missing coverage.

Instructions

Read a background synchronization job. Report partial failures and missing coverage explicitly.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
job_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile needs no restating. The description adds genuine value by warning that results may be partial with missing coverage, but omits polling behavior, terminal states, or whether job_id must come from an active job.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with the core action front-loaded and no filler. The second sentence earns its place by flagging partial-failure reporting, though it reads slightly like an instruction to the caller rather than tool documentation.

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

Completeness3/5

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

With no output schema, the description carries the burden of explaining return values, and it only gestures at partial failures and coverage gaps without enumerating job states or progress fields. Adequate for a single-parameter status read, but an agent still cannot predict the response shape.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% for the single parameter, so the schema does not describe job_id at all (only a pattern constraint), and the description does not compensate by saying where the id originates or what a valid id refers to.

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 names a specific verb and resource ('Read a background synchronization job'), which is precise enough for an agent to know it inspects state rather than triggering work. It does not, however, differentiate itself from the sibling 'sync' tool or explain the relationship to 'connection_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 on when to call this versus 'sync' (which presumably starts a job), whether the job_id comes from a prior 'sync' call, or how often to poll. The second sentence describes result handling, not usage conditions.

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