Skip to main content
Glama

get_subscription_by_short_uuid_protected

Read-only

Fetch a Remnawave subscription by short UUID via the protected read-only endpoint. Use for safe subscription lookup in MCP chats.

Instructions

Get subscription by short uuid (protected route) [READ] GET /api/subscriptions/by-short-uuid/:shortUuid

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shortUuidYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

C2.7/5.0
Behavior2/5

Does 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's only added behavioral claim is 'protected route', which is unexplained jargon — it does not say what auth or permission is required, or what that protection means for the caller's behavior.

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

Conciseness4/5

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

Very short and front-loaded: purpose first, then route/HTTP method. The endpoint string is largely redundant metadata, but nothing is bloated or buried.

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 output schema, no explanation of the return payload, no explanation of 'protected', and a completely undocumented required parameter, the description leaves too much for the agent to infer about a tool that fetches a subscription object.

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% for the single required shortUuid parameter, and the description only echoes the name ('by short uuid') without format, source, or validation details. It does not compensate for the undocumented parameter.

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 names a specific verb+resource (get subscription) plus the lookup key (short uuid), which is clearer than a bare name restatement. However, it fails to differentiate from the near-identical sibling get_subscription_info_by_short_uuid or explain what 'protected' adds, 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.

Usage Guidelines2/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 versus get_subscription_by_id, get_subscription_by_username, or the very similar get_subscription_info_by_short_uuid. The '(protected route)' parenthetical hints at a different access context but never states when an agent should pick this one.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools