Skip to main content
Glama

get_top_users_by_hwid_devices

Read-only

Rank users by HWID device count on a Remnawave panel, with size and offset controls for paginated results.

Instructions

Get top users by HWID devices [READ] GET /api/hwid/devices/top-users

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sizeNoNumber of results to return, no more than 100
startNoStart index (offset) of the results to return, default is 0

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

C2.7/5.0
Behavior3/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 '[READ] GET /api/hwid/devices/top-users' tag only restates that read-only nature and adds no new behavioral context such as sorting rules, time window, or pagination behavior. Consistent with annotations, but adds little 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?

It is short, front-loaded, and free of bloat, so nothing is wasted. However it is under-specified rather than merely concise — the two lines add nothing an agent could not infer from the name and endpoint tag.

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 stats-style endpoint with no output schema, the description leaves key questions unanswered: what 'top' is sorted by, whether it is scoped by time, and what a returned 'user' entry contains. With no output schema to compensate and no usage context, an agent lacks enough to use it confidently against its HWID siblings.

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%, with both size and start fully documented in the schema including bounds and defaults. The description says nothing about parameters, so baseline 3 applies — the schema carries the entire burden and the description contributes nothing extra.

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?

The description is essentially the tool name restated ('Get top users by HWID devices') plus an HTTP endpoint tag, so it does convey a verb and resource but adds no clarifying detail. It gives no differentiation from near-neighbors like get_hwid_devices_stats, get_hwid_devices, or get_user_hwid_devices. What 'top' means (ranked by device count, over what window) is left undefined.

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 prerequisites, and no reference to the several HWID-related sibling tools. An agent has no basis to choose this over get_hwid_devices_stats or get_user_hwid_devices from the text alone.

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