subscriptions_get_by_short_uuid
Retrieve a subscription by its short UUID from the Remnawave VPN panel's protected API route.
Instructions
Get subscription by short uuid (protected route)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| shortUuid | Yes |
Retrieve a subscription by its short UUID from the Remnawave VPN panel's protected API route.
Get subscription by short uuid (protected route)
| Name | Required | Description | Default |
|---|---|---|---|
| shortUuid | 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 clear. The description adds only '(protected route)', which vaguely suggests authentication or authorization requirements without specifying them.
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?
The description is a single front-loaded phrase with no filler. It is efficient, though the '(protected route)' parenthetical is vague and the overall brevity leaves gaps better addressed elsewhere.
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 simple single-parameter lookup with annotations covering read-only safety, the definition is minimally viable. However, it omits any routing guidance among several similar subscription lookup siblings and leaves the parameter semantics unexplained.
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?
The schema has 0% description coverage for the single required string parameter shortUuid. The description only echoes 'short uuid'; it does not explain the expected format, origin, or constraints of a short UUID.
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 and resource ('Get subscription') and the lookup key ('short uuid'). This distinguishes it from sibling lookups by user ID or username, though it does not clarify how it differs from subscriptions_get_raw_by_short_uuid.
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?
Provides no guidance on when to use this tool versus subscriptions_get_raw_by_short_uuid, subscriptions_get_by_user_id, or subscriptions_get_by_username. The '(protected route)' note hints at access context but is not an explicit usage condition.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.