Skip to main content
Glama

update_play_queues_by_play_queue_id_reset

Idempotent

Reset a Plex play queue to its initial state using its ID. Restores the original order and removes any changes made to the queue.

Instructions

Reset a play queue.

PUT /playQueues/{playQueueId}/reset

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.2/5.0
Behavior2/5

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

The description adds no behavioral detail beyond the annotated hints. It does not explain what 'reset' changes (playback position, queue order, or item history), nor any side effects, despite the annotations indicating a non-read-only, idempotent, non-destructive mutation.

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 tightly structured: a one-sentence purpose, the HTTP endpoint, and the argument list. It contains no filler, though the Args section largely repeats schema 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 single-parameter operation with an output schema and safety annotations, the description is minimally viable. However, 'reset' remains ambiguous in effect, and there is no statement about what state is reset or what the response represents, leaving an agent to rely on domain assumptions.

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?

With schema description coverage at 0%, the description must define the parameter. 'play_queue_id: The ID of the play queue' provides a basic identifier meaning but is only slightly more informative than the schema's title 'Play Queue Id'; it does not add format, source, or validation context.

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 'Reset a play queue.', a specific verb and resource. The endpoint 'PUT /playQueues/{playQueueId}/reset' confirms the exact operation, and 'reset' differentiates this from sibling mutations like shuffle, unshuffle, and update.

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?

No guidance is given on when to call reset versus related play-queue operations. The description states only what the endpoint does, with no mention of prerequisites, scenarios, or exclusions, so an agent must infer usage from the tool name alone.

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