Skip to main content
Glama

getTrafficDistribution

Read-only

Retrieve traffic distribution by protocol and application category over a time range to identify which applications consume network bandwidth.

Instructions

Get traffic distribution by protocol and application type over a time range. Shows breakdown of traffic by category (video, gaming, web, etc.) helping identify what is consuming bandwidth on the network. start and end are Unix timestamps in seconds.

Input Schema

NameRequiredDescriptionDefault
endYesEnd of the time range as a Unix timestamp in seconds (e.g. Math.floor(Date.now() / 1000)). Must be paired with start.
startYesStart of the time range as a Unix timestamp in seconds (e.g. Math.floor(Date.now() / 1000) - 3600 for the last hour). Must be paired with end.
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.0-rc.1

TDQS

A3.5/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 safety is conveyed structurally. The description adds the useful scoping detail that results are grouped by traffic category (video, gaming, web, etc.), but it says nothing about aggregation granularity within the range, cardinality of results, or the fact that omitting siteId falls back to a configured default site.

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 short sentences, front-loaded with what the tool returns before the explanatory benefit statement. The final timestamp sentence is largely redundant with the schema, which is the only real waste.

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?

For a 3-parameter read-only tool with full schema coverage and safety annotations, the description covers purpose, output dimension, and a concrete example of the categories returned, which partially compensates for the absent output schema. Missing only edge details such as granularity of the breakdown and default-site behavior.

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 all three parameters including the siteId default behavior and the Unix-seconds format are already fully documented in the schema. The trailing sentence about start and end being Unix timestamps in seconds restates the schema rather than adding new meaning, 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 traffic distribution") plus the dimensions it breaks down by (protocol and application type) over a time range, which is concrete enough to separate it from neighbors like getClientsDistribution or getDashboardTrafficActivities. It stops short of explicitly naming a sibling it is not, so a 4 rather than a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The clause "helping identify what is consuming bandwidth on the network" implies the intended use case, and the required time range hints that this is a windowed analysis call. But there is no explicit when-to-use/when-not guidance and no pointer to an alternative tool for related questions such as per-client rather than per-category traffic.

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