Skip to main content
Glama

update_library_metadata_by_ids_index

Idempotent

Trigger BIF index generation for specified Plex media item IDs to produce video preview thumbnails. Optionally force the operation.

Instructions

Start BIF generation of an item.

PUT /library/metadata/{ids}/index

Args: ids: Comma-separated list of IDs force: Force the operation even if conditions are not met

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsYes
forceNo

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?

The description adds a small amount of behavioral context beyond the annotations: 'Start' implies an asynchronous initiation, and 'force' implies that the operation normally checks some conditions before proceeding. However, it does not disclose what those conditions are, what happens to existing BIF data, or whether the call returns immediately or waits for completion. No contradiction with the annotations exists.

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 description is compact and front-loaded with the core purpose, followed by the endpoint and parameter explanations. Every line earns its place, with no redundant or filler prose.

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?

An output schema exists, so return-value documentation is not needed. The description covers the two parameters and the basic action, but it does not explain what BIF is, whether multiple IDs are processed as one batch, or what conditions the 'force' flag bypasses. For a tool in a large family of similarly named update_library_metadata_by_ids_* operations, slightly more context would improve completeness.

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%, so the description must compensate, and it partially does: 'ids: Comma-separated list of IDs' adds format details absent from the schema, and 'force: Force the operation even if conditions are not met' clarifies the flag's purpose. The force explanation is somewhat vague about what conditions are involved, but both parameters receive meaningful semantic elaboration.

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 states a specific action ('Start BIF generation') on a specific resource ('an item' in the library metadata), and includes the HTTP endpoint. This distinguishes it from many sibling update_library_metadata_by_ids_* tools, though 'BIF' is never defined and the singular 'item' sits awkwardly against the plural 'ids' parameter.

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 use this tool versus alternatives such as update_library_metadata_by_ids_analyze, update_library_metadata_by_ids_refresh, or update_library_metadata_by_ids_credits. The only implicit cue is the word 'Start', which suggests an asynchronous generation action, but no explicit when/when-not conditions or alternative routing are provided.

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