Skip to main content
Glama

external_squad_get_external_squad_by_uuid

Retrieve a specific external squad by UUID to inspect its details, configuration, or metadata in the Remnawave panel.

Instructions

GET /api/external-squads/{uuid} Get external squad by uuid Tags: External Squads Controller

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesUUID of the external squad

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.6/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 behavioral burden, yet it only echoes the route signature. The HTTP verb implies a read, but there is no statement about authentication requirements, error behavior for unknown UUIDs, or whether the response is cached/partitioned.

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?

It is short and front-loaded, but the trailing "Tags: External Squads Controller" is classifier noise with no value to an agent, and the raw route line duplicates information already conveyed by the name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter GET with no output schema, the description is only barely sufficient — it confirms this returns one squad identified by UUID. It omits return-shape hints and failure modes, which an agent would need to plan around.

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

Parameters3/5

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

Schema description coverage is 100% and the single uuid parameter is fully documented in the schema, so the baseline is 3. The description's "{uuid}" path token adds no meaning beyond what the schema already states.

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

Purpose3/5

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

"Get external squad by uuid" names a verb and resource and the identifying key, so the intent is unambiguous, but it is nearly a verbatim restatement of the tool name and adds nothing about what an 'external squad' is. No differentiation from the sibling external_squad_get_external_squads (list all) is offered.

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 at all. The description never says when to fetch a single squad versus the collection endpoint, nor mentions any precondition (squad must exist, valid UUID).

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