Skip to main content
Glama

getBandwidthCtrlDetail

Get gateway bandwidth control detail settings for a site, including per-IP and per-SSID bandwidth limits.

Instructions

Get gateway bandwidth control detail settings for a site, including per-IP and per-SSID bandwidth limits.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "getBandwidthCtrlDetail"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.
customHeadersNoOptional HTTP headers to include in the Omada API request (e.g. {"X-Custom-Header": "value"}). Rarely needed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.18.0

TDQS

C2.9/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 says what data is fetched. It does not confirm the operation is a safe read, does not describe failure modes (no gateway at site, invalid siteId), and says nothing about the shape or size of the returned settings.

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?

A single well-formed sentence with the resource and scope front-loaded and no filler. It is arguably slightly thin rather than wasteful, but nothing in it fails to earn its place.

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 simple two-parameter read getter with full schema coverage this is close to adequate, but with no annotations and no output schema the description should say more about what 'detail settings' contains or what happens when the site has no gateway. Minimum viable rather than complete.

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%: siteId documents default-site fallback and points to listSites, and customHeaders explains itself. The description adds no parameter meaning beyond the schema, so the baseline 3 applies.

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 gateway bandwidth control detail settings for a site', and further scopes the content to per-IP and per-SSID bandwidth limits. This is distinguishable from QoS/traffic-priority siblings like getQosPolicy or getTrafficPriority, though the description never explicitly contrasts with them.

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?

No guidance on when to use this versus alternatives such as getGatewayQosClassRules, getQosPolicy, or getTrafficPriority, which all sit in the same gateway-QoS neighborhood. No prerequisites (e.g. gateway must exist at the site) or exclusions are stated.

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