Skip to main content
Glama

users_get_user_by_username

Look up a Remnawave user by username and return their account record from the panel API.

Instructions

GET /api/users/by-username/{username} Get user by username Tags: Users Controller

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
usernameYes

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?

No annotations, so the description carries the full burden. It reveals nothing beyond the route: no auth requirements, no behavior for missing users, no indication of what fields are returned. The 'Tags: Users Controller' line is an OpenAPI artifact with no operational value.

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?

Very short, which is fine, but the content is largely a restatement of the endpoint route plus a redundant title echo and a useless 'Tags' line. Front-loaded but low signal density.

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 a lookup tool in a crowded users namespace with no annotations and no output schema, the description does not provide enough to confidently select or invoke it over the id/short_uuid/resolve variants. Missing return shape and error semantics.

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?

Schema coverage is 0% and there is 1 parameter, but the parameter name 'username' is self-describing and matches the description's wording. No format hints (case sensitivity, exact-match vs fuzzy) are added, so it stays at baseline.

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?

Clear verb+resource: 'Get user by username' with the HTTP route GET /api/users/by-username/{username}. The purpose is unambiguous, though it does nothing to distinguish itself from the many sibling retrieval tools (users_get_user_by_id, users_get_user_by_short_uuid, users_resolve_user, subscriptions_get_subscription_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?

No when-to-use guidance, no alternatives named, no distinction from users_get_user_by_id or the short_uuid variant. The agent must infer selection from the name alone.

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