Skip to main content
Glama

trmnl_update_playlist_item

Update a playlist item's appearance, visibility, and palette so per-item overrides replace the device defaults; set a field to null to restore the device setting.

Instructions

Update a playlist item The appearance fields override the device's own for this item; null returns one to the device default. listPalettes names the palettes a device model has. TRMNL PATCH /api/playlists/items/{id}. Changes remote state or starts work. Run only within the user-authorized scope.

Input Schema

NameRequiredDescriptionDefault
bodyNo
pathYes
profileNoConfigured profile name; defaults to default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=true, and the line 'Changes remote state or starts work' largely restates that. The description does add genuine behavioral context that annotations cannot convey: setting an appearance field to null resets it to the device default, and fields override the device's own values for that item. Return behavior and permission requirements are still unstated.

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

Conciseness3/5

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

The core semantics (override + null default) are front-loaded and earn their place, but the trailing 'Changes remote state or starts work. Run only within the user-authorized scope.' is generic boilerplate adding little. The dangling 'listPalettes' sentence is also noise that doesn't map to any parameter.

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 mutation tool with a nested body object, 33% schema coverage, and no output schema, the description covers the most important ambiguity (null means reset to device default) but leaves the update's semantics incomplete — no mention of partial vs full replacement, enum options for text_scale, or what the response contains.

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 only 33% schema description coverage, the description usefully explains the null-to-default semantics of the appearance fields (theme, palette_id, font_family, text_scale) and the override behavior. However, 'visible' is never addressed, and the 'listPalettes' reference is confusing since no such parameter exists in the schema — it appears to point at a separate tool.

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 a specific verb+resource ('Update a playlist item') and adds the endpoint (PATCH /api/playlists/items/{id}), which clearly separates it from siblings like trmnl_delete_playlist_item, trmnl_duplicate_playlist_item, or trmnl_bulk_update_device_playlist. It does not explicitly name those siblings, but the operation type is unambiguous.

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?

It never states when to use this versus trmnl_bulk_update_device_playlist, trmnl_replace_playlist_item_schedule, or trmnl_update_device. The only guidance-like sentence ('Run only within the user-authorized scope') is generic safety boilerplate rather than a usage condition.

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