Skip to main content
Glama

get_subpage_config_by_short_uuid

Read-only

Retrieve a subscription's subpage configuration by its short UUID to inspect public page settings in a Remnawave panel.

Instructions

Get Subpage Config by Short UUID [READ] GET /api/subscriptions/subpage-config/:shortUuid

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shortUuidYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

C2.1/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, and the '[READ]' prefix plus the GET path merely repeat that read-only fact rather than adding new context. Nothing is said about what the subpage config contains, whether it requires subscription-scoped auth, or error behavior for unknown short UUIDs. It does not contradict the annotations, but adds nothing beyond them.

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?

Very short and front-loaded, with no filler, but the brevity reflects under-specification rather than disciplined concision — it is a title plus an endpoint line with no substantive content.

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 read tool with no output schema and an undocumented parameter, the description should explain what the returned subpage config is and how it relates to sibling config tools. Instead it gives only a name and route, leaving the agent unable to confidently select or invoke it.

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 required parameter 'shortUuid' is completely undocumented. The description never explains what a short UUID is, its format, or how it differs from the UUID accepted by sibling get_subpage_config, so it fails to compensate for the schema gap.

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 essentially the tool name restated plus the HTTP endpoint: 'Get Subpage Config by Short UUID' / 'GET /api/subscriptions/subpage-config/:shortUuid'. It does not distinguish this tool from close siblings like get_subpage_config, get_subpage_configs, or get_subscription_by_short_uuid_protected, so an agent cannot tell which subpage-config variant to pick.

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 when-to-use guidance, no statement of when to prefer this over get_subpage_config (which likely takes a full UUID) or the list endpoint get_subpage_configs. The reader must infer the selection rule purely from the name.

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