Skip to main content
Glama

subscription_get_subscription

Retrieve a subscription by short UUID to view its current status and settings through the Remnawave panel API.

Instructions

GET /api/sub/{shortUuid} Tags: [Public] Subscription Controller

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shortUuidYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.8/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 disclosure burden, and it delivers almost nothing. The '[Public]' tag weakly implies unauthenticated access, which is a useful behavioral hint, but there is no mention of auth requirements, error behavior, or what data is exposed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is short, but the brevity comes from omitting content rather than trimming waste; a route string and a tag line are not a useful description. There is no front-loaded purpose statement.

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% schema coverage on the sole parameter, the description must supply context and supplies none beyond the endpoint path. An agent cannot determine return shape, auth needs, or how this differs from the numerous sibling subscription lookups.

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 parameter shortUuid has no description. The path template shows shortUuid is required and is a path segment, but no format, length, or meaning (e.g., what a 'short' UUID is versus a full UUID) is conveyed.

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

Purpose2/5

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

The description is a raw HTTP route plus a controller tag: 'GET /api/sub/{shortUuid}'. It signals a retrieval of a subscription keyed by shortUuid, but adds no semantic description of what is returned or how this differs from the many sibling subscription getters (by uuid, by username, by client type, raw, subpage config). This is close to restating the tool name in URL form.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/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 endpoint versus subscriptions_get_subscription_by_uuid, subscriptions_get_subscription_by_short_uuid_protected, subscription_get_subscription_info_by_short_uuid, or the raw/subpage variants. Nothing indicates preconditions or selection criteria.

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