Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_bandwidth_usage

Read-only

Retrieve top devices by combined upload and download bandwidth over a selected time period, optionally scoped to a specific Firewalla box. Helps identify high-bandwidth consumers.

Instructions

Top devices by upload plus download over the period, summed client-side from up to 10 times limit (1,000 at most) of the period's most recent flows (GET /v2/flows, 500 per request), so on a busy network the totals cover a sample. Scoped to box, else FIREWALLA_BOX_ID, else every box.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boxNoOnly flows of this box (box gid). Defaults to FIREWALLA_BOX_ID; without either, every box.
limitNoNumber of top devices to return
periodYesTime period for bandwidth calculation
response_formatNoResponse format. 'json' (default): the compact JSON response. 'markdown': the same response as readable markdown, its fields as bullet lists and each list of records as a table of up to 8 columns and DEFAULT_PAGE_SIZE rows (default 100), ending with a line that says what the view leaves out. Omitted or null: 'json'. Errors are JSON either way.json

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.1
    • addedInput schema / properties / response_format
      Added value: +{
+  "default": "json",
+  "description": "Response format. 'json' (default): the compact JSON response. 'markdown': the same response as readable markdown, its fields as bullet lists and each list of records as a table of up to 8 columns and DEFAULT_PAGE_SIZE rows (default 100), ending with a line that says what the view leaves out. Omitted or null: 'json'. Errors are JSON either way.",
+  "enum": [
+    "json",
+    "markdown",
+    null
+  ],
+  "type": [
+    "string",
+    "null"
+  ]
+}
  2. Changed1 schema field changedv1.5.0
    • changedInput schema / properties / box / description
      Previous value: -"Filter devices under a specific Firewalla box"New value: +"Only flows of this box (box gid). Defaults to FIREWALLA_BOX_ID; without either, every box."
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=true, openWorldHint=true), and the description adds meaningful behavior beyond that: the totals are summed client-side from a bounded, sampled set of recent flows, so on a busy network the result is approximate. Disclosing this accuracy caveat is real value. It doesn't cover auth or rate limits, but the sampling disclosure is the key trait.

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?

It is a single dense sentence, front-loading the purpose and then the derivation. It is appropriately sized and every clause carries information, though the run-on structure makes it harder to parse quickly than a couple of short sentences would.

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 read-only analytics tool with annotations covering safety and no output schema, the description supplies the essential behavioral context (sampling, scoping). It does not describe the shape of the returned device list, but the annotations and stated metric cover most of what an agent needs to invoke it correctly.

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

Parameters4/5

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

Schema coverage is already 100%, so baseline is 3, but the description adds genuine meaning: it explains that `limit` drives a fetch of up to 10×limit flows (1,000 max), revealing the cost/accuracy tradeoff behind that parameter. The `box` scoping logic is restated, which duplicates the schema slightly.

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?

The description states a specific output (top devices by upload+download over a period), giving an agent a clear picture of the resource and metric. It does not explicitly differentiate itself from analytics siblings like get_simple_statistics or get_statistics_by_box, so it stops short of 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?

It explains the scoping logic (box, else FIREWALLA_BOX_ID, else every box), which is useful context for choosing inputs. However, it never states when to reach for this tool versus alternatives like search_flows or get_statistics_by_box, leaving usage selection implied.

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