Skip to main content
Glama

users_get_user_by_short_uuid

Retrieves a user from the Remnawave panel using a short UUID, so you can identify accounts when only the abbreviated ID is known.

Instructions

GET /api/users/by-short-uuid/{shortUuid} Get user by Short UUID Tags: Users Controller

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shortUuidYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.4/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It implies a read-only operation by exposing the GET route, but says nothing about authentication requirements, behavior when the UUID is not found, or whether related entities are included.

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?

It is short and front-loaded with the essential verb+resource, but the pasted HTTP route and 'Tags: Users Controller' metadata are noise that convey little to an agent selecting or calling the tool.

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?

With no annotations, no output schema, and 0% parameter description coverage, the description should compensate but does not. For a lookup tool an agent needs at least the identifier semantics and error behavior, neither of which is present.

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%, and the single required parameter shortUuid is undocumented in the schema. The description only surfaces it inside the route template, adding no explanation of what a 'short UUID' is, its format, or whether it is case-sensitive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear verb+resource ('Get user by Short UUID'), which is understandable on its own. However, it largely restates the tool name and adds only the raw HTTP route, offering no explicit differentiation from close siblings such as users_get_user_by_id or users_get_user_by_username.

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 on when to use this tool versus the id-based or username-based lookup siblings, nor any prerequisites (e.g., which UUID format is required). The agent must infer selection criteria purely from the name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools