Skip to main content
Glama
Sign In
remnawave-mcp

remnawave-mcp

by 3APA3A-3AHO3A
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_internal_squad_usage

Read-only

Retrieve traffic usage for users in an internal squad over a date range, returning those meeting a minimum total bytes threshold on squad-reachable nodes.

Instructions

Get internal squad users traffic usage for a period Returns users whose total usage over the period on the given nodes is >= minTotalBytes, scoped to the nodes reachable via the internal squad inbounds. Underlying usage data is flushed to the database roughly every 2 minutes. [READ] GET /api/bandwidth-stats/internal-squads/:uuid/usage

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "uuid": "<uuid>",
      "start": "<start>",
      "end": "<end>"
    },
    "name": "get_internal_squad_usage"
  }
}

Input Schema

NameRequiredDescriptionDefault
endYesEnd date (YYYY-MM-DD)
uuidYesInternal squad UUID
limitNoNumber of users to return, no more than 1000
startYesStart date (YYYY-MM-DD)
cursorNoPass the nextCursor from the previous response. Omit on the first request.
minTotalBytesNoOnly include users whose total usage over the period is >= this (bytes)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A3.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations cover the safety profile (readOnlyHint=true, destructiveHint=false), and the description adds useful behavioral context beyond them: the >= minTotalBytes threshold filter, node scoping through internal squad inbounds, and a data-freshness caveat ('flushed to the database roughly every 2 minutes'). Pagination behavior is not mentioned, but the freshness note is genuinely valuable.

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?

Three sentences plus an endpoint tag, front-loaded with the tool's purpose and filtering behavior. The endpoint citation is somewhat redundant with the tool's operation but still compact and informative; no sentence is wasted.

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

Completeness4/5

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

With no output schema, the description is responsible for conveying what returns; it does so via the threshold and node-scoping explanation. Parameters are fully documented and the freshness caveat is included, though pagination/cursor behavior could be worth a sentence for a 6-param endpoint.

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%, so the schema already documents all six parameters, including minTotalBytes, cursor, limit, and dates. The description reinforces the minTotalBytes filter and node scoping but adds no syntax or format detail beyond what the schema provides, making the baseline 3 appropriate.

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?

States a specific verb and resource ('Get internal squad users traffic usage for a period') and clarifies the filtering semantics (>= minTotalBytes, scoped to nodes reachable via internal squad inbounds). It is clear what the tool returns, but it never differentiates itself from very similar siblings like get_internal_squad_user_usage or get_stats_user_usage.

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?

The description gives no explicit when-to-use or when-not-to-use guidance, and no alternative tool is named. Because get_internal_squad_user_usage is a near-identical sibling in the tool list, this omission is a meaningful gap for an agent trying to route between them.

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