Skip to main content
Glama

create_home_users_by_id_switch

Idempotent

Switches the active Plex Home user by specifying the target user's unique ID, enabling quick user context changes.

Instructions

Switch Home User.

POST /home/users/{id}/switch

Args: id: The unique identifier of the item

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.8/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. The description adds nothing beyond the bare 'Switch Home User' phrase and the HTTP endpoint, so it does not meaningfully explain side effects, session changes, or other behavioral implications beyond what annotations already convey.

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 extremely short and front-loads the core action, with the endpoint and argument list following immediately. It contains no filler, though the brevity comes at the cost of semantic depth.

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 tool with annotations and an output schema present, the description provides enough to make a basic call: the verb, resource, endpoint, and required id. However, it leaves usage context and behavioral nuance unstated, so it is only minimally complete.

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

Parameters2/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 for the sole parameter 'id'. However, it only says 'The unique identifier of the item', which is nearly as generic as the schema and does not clarify that the id refers to a Home User or explain how the id should be obtained.

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 concrete action and resource: 'Switch Home User' plus the endpoint 'POST /home/users/{id}/switch'. This is clear enough to distinguish it from sibling tools like update_home_users_by_user_id, but it does not explicitly contrast itself with those alternatives.

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 the many related home-user tools such as create_home_users, update_home_users_by_user_id, or delete_home_users_by_user_id. The description only restates the action and endpoint, leaving all usage decisions to the agent.

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