Skip to main content
Glama

update_home_users_by_user_id

Idempotent

Update a Plex home user's settings by providing their unique user ID via the Plex API. Use this tool to modify home user details.

Instructions

Update Home User.

PUT /home/users/{userId}

Args: user_id: The unique identifier of the user

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, but the description adds no behavioral detail beyond the word 'Update'. It does not disclose what happens to existing settings, whether the update is a merge or replace, any authorization requirements, or side effects. No contradiction with annotations exists, but the description also provides no added transparency.

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-loaded with the purpose, followed by the HTTP method/path and an argument list. Every sentence earns its place and there is no filler. It sacrifices detail for brevity, but as a concise structure it is effective.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an update operation, the description is incomplete: it does not say what fields can be updated, whether a request body is required, or how the update behaves. With only a single parameter listed and no body information, an agent cannot determine how to construct a valid update call beyond the user ID. The existence of update_home_users_restricted_by_user_id hints at a more specific variant, but no distinguishing context is provided.

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?

The schema provides only the title 'User Id' with no description (0% coverage), so the description must carry the semantic weight. It does offer 'user_id: The unique identifier of the user', which adds a minimal clarification beyond the schema. However, it does not explain constraints, how the ID is used, or any relationship to the update body.

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 'Update Home User.', which is a clear verb-plus-resource statement and immediately identifies the operation. It also provides the HTTP method and path, reinforcing the purpose. However, it does not differentiate this tool from sibling tools such as update_home_users_restricted_by_user_id, and 'Home User' is left somewhat ambiguous.

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?

The description gives no guidance on when to use this tool versus the many related home-user tools like create_home_users, update_home_users_restricted_by_user_id, or delete_home_users_by_user_id. No prerequisites, use-cases, or exclusions are mentioned. The only extra context is the endpoint and parameter listing.

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