users_get_by_username
Fetch a Remnawave 3.x VPN user record by username to review account status, subscription, and panel configuration.
Instructions
Get user by username
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Fetch a Remnawave 3.x VPN user record by username to review account status, subscription, and panel configuration.
Get user by username
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Changes observed during successful MCP inspections.
v3.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds nothing beyond that: no return shape, no behavior when the username is unknown, no pagination or error context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with zero filler. It is efficient, though the terseness borders on under-specification rather than disciplined brevity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter lookup with no output schema, the definition is barely sufficient: it does not describe the returned user object or the not-found case, which an agent would benefit from knowing since no output schema supplies it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
One required parameter with 0% schema description coverage, so the description must carry the load. It does convey that the parameter is a username identifier via 'by username', which is the minimum needed, but adds no format, case-sensitivity, or validity detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Get') and resource ('user') plus the distinguishing lookup key ('by username'), which meaningfully separates it from users_get (by id), users_get_by_short_uuid, and users_resolve. It does not explicitly name those siblings, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
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 versus the many alternative user-lookup tools (users_get, users_get_by_short_uuid, users_resolve). The only implicit signal is the 'by username' key in the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.