Skip to main content
Glama

subscriptions_get_subscription_by_short_uuid_protected

Retrieves a subscription from the Remnawave panel using its short UUID via a protected route, returning subscription details for a given short identifier.

Instructions

GET /api/subscriptions/by-short-uuid/{shortUuid} Get subscription by short uuid (protected route) Tags: [Protected] Subscriptions 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?

With no annotations, the description carries full behavioral burden. 'GET' implies a safe read and 'protected route' vaguely hints at authorization, but the description does not state what authentication is required, what data is returned, or how the protected route behaves differently from unprotected variants.

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?

The description is short and front-loads the primary action, but the opening raw endpoint and trailing 'Tags' line add little value for an agent selecting the tool. It is not verbose, but the structure is more HTTP annotation than agent-facing guidance.

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 simple lookup with one parameter and no output schema, the description still lacks essential context such as authentication requirements implied by 'protected route' and what the response contains. It is insufficient to call the tool correctly with confidence.

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

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single required parameter shortUuid. The description only repeats '{shortUuid}' from the path without adding format, constraints, or meaning beyond what the schema already declares as a string.

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 clear verb and resource: 'Get subscription by short uuid.' The '(protected route)' qualifier distinguishes it from unprotected or raw subscription retrieval siblings, but the description does not explain what 'protected' means or how it differs from other by-short-uuid tools.

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 guidance is given on when to use this tool versus siblings like subscriptions_get_raw_subscription_by_short_uuid, subscriptions_get_subscription_by_uuid, or subscription_get_subscription_info_by_short_uuid. The protected-route label hints at a prerequisite but does not explain it.

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