Skip to main content
Glama

get_sync_items_by_sync_id

Read-onlyIdempotent

Retrieve details of a Plex sync item by its unique ID to check status, settings, or troubleshoot sync issues.

Instructions

Get Sync Item.

GET /sync/items/{syncId}

Args: sync_id: The unique identifier of the sync item

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sync_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds no behavioral context beyond the endpoint, but it does not contradict the annotations either.

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?

The description is compact and front-loaded: a short title, the endpoint, and an argument explanation. Nearly every line earns its place, though 'Get Sync Item.' is largely redundant with the tool name.

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?

For a simple idempotent getter with an output schema and full annotations, the main gap is missing domain context: what a sync item is, how to obtain a sync_id, and how this relates to list_sync_items. Otherwise the description is sufficient.

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?

The schema gives title 'Sync Id' with no description, so the Args section compensates, but 'unique identifier of the sync item' adds little beyond what the title and tool name already imply. It is minimal enrichment rather than a substantive explanation.

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 opens with 'Get Sync Item,' a clear verb and resource, and adds the specific endpoint path `GET /sync/items/{syncId}`. However, it never defines what a sync item is or differentiates from sibling tools like list_sync_items, leaving scope slightly vague.

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 endpoint and parameter name imply this is for fetching a single sync item by its ID, but the description provides no explicit when-to-use guidance or mention of alternatives. It only restates what is already inferable from the tool name and schema.

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

Deploy Server

Other Tools