Skip to main content
Glama

update_play_queues_by_play_queue_id_shuffle

Idempotent

Shuffle a play queue by providing its play queue ID to randomize the playback order in Plex.

Instructions

Shuffle a play queue.

PUT /playQueues/{playQueueId}/shuffle

Args: play_queue_id: The ID of the play queue.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
play_queue_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already convey that this is not read-only, is non-destructive, and is idempotent; the description adds the PUT method and path but does not describe the effect on the queue order or whether a previous order is recoverable. This is adequate for a simple mutation but lacks richer context.

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 very short and front-loads the action, with no filler. The endpoint and Args block are mildly redundant with the schema but still compact and scannable.

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 one-parameter operation with annotations and an output schema, the call is mostly self-contained, but the description leaves usage selection and the exact outcome of 'shuffle' unstated. It is functional without being a complete guide.

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 description coverage is 0%, and the description's only parameter note — 'The ID of the play queue' — mostly restates the schema title 'Play Queue Id.' It does not add format, bounds, or usage nuance beyond what the parameter name already implies.

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 'Shuffle a play queue,' naming a specific verb and resource, and reinforces it with the explicit PUT path. It does not make the contrast against sibling operations such as unshuffle or reset explicit, so it misses the top score.

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 choose this tool over alternatives like update_play_queues_by_play_queue_id_unshuffle or reset, and no prerequisites or exclusions are stated. The intended use must be inferred from the tool name and one-line action.

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