Skip to main content
Glama

update_play_queues_by_play_queue_id

Idempotent

Add a playlist or media generator to an existing Plex play queue by its ID, with optional play-next behavior.

Instructions

Add a generator or playlist to a play queue.

PUT /playQueues/{playQueueId}

Args: play_queue_id: The ID of the play queue. uri: The content URI for what we're adding to the queue. playlist_id: The ID of the playlist to add to the playQueue. next: Play this item next (defaults to 0 - queueing at the end of manually queued items).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriNo
nextNo
playlist_idNo
play_queue_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already indicate this is a mutating but non-destructive, idempotent operation. The description adds useful detail beyond annotations: the HTTP method and that `next` defaults to 0, meaning the item queues at the end of manually queued items. It does not discuss repeated-call behavior, duplicate handling, or response side effects, so there is room above, but it does not contradict 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?

The definition is compact and front-loaded: one sentence states the operation, then the endpoint and an Args list give parameter details without repetition or filler. Every line carries useful information.

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 four-parameter tool with one required field, this is mostly sufficient: it identifies the queue, the item(s) to add, and the optional next behavior. However, it does not spell out the relationship between `uri` and `playlist_id` (whether only one may be supplied or both are allowed), which is a material gap for an agent constructing a valid call.

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

Parameters4/5

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

Schema description coverage is 0%, and the description compensates by explaining all four parameters: `play_queue_id` is the target queue, `uri` is the content to add, `playlist_id` selects a playlist, and `next` controls placement with a default. It could clarify whether `uri` and `playlist_id` are alternatives or combinable, but it adds substantial value over the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific action and object: 'Add a generator or playlist to a play queue.' This clearly differentiates the operation from sibling play-queue tools such as move, reset, or shuffle, and matches the verb in the tool name without merely restating it.

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 intended use is implied by 'Add'—this is the tool to put a generator or playlist into an existing play queue—but there is no explicit when-to-use/when-not-to-use guidance or mention of alternatives like delete_play_queues_by_play_queue_id_items for removal. Sibling context alone is not enough to route an agent confidently.

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