Skip to main content
Glama
amittell

firewalla-mcp-server

get_statistics_by_region

Read-only

Identify top regions by blocked network flows for a Firewalla box group. Get up to five regions to pinpoint where threats originate.

Instructions

Top regions by blocked flows, from GET /v2/stats/topRegionsByBlockedFlows, optionally for one box group; the API returned no more than 5 regions. Not limited by FIREWALLA_BOX_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
groupNoGet statistics for specific box group
limitNoMaximum number of regions (optional, default: 5; the API returned no more than 5 when a larger limit was tried)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.5.0
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of results (optional, default: 5)"New value: +"Maximum number of regions (optional, default: 5; the API returned no more than 5 when a larger limit was tried)"
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

With readOnlyHint=true already signaling a safe read operation, the description adds useful behavioral detail: the API caps results at 5 regions even when a larger limit is requested, and the query is not constrained by FIREWALLA_BOX_ID. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One tight sentence front-loads the result semantics and packs in endpoint, optional filter, API cap, and scope limitation without wasted words. Every clause adds useful information.

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

Completeness5/5

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

For a simple read-only statistics tool with two optional parameters and no output schema, the description plus schema fully covers what an agent needs: what is returned, the optional group filter, the limit behavior, and the scope. The readOnly and openWorld annotations complement the description.

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 coverage is 100%, and both parameters (group, limit) are already described with meaningful detail including default and minimum. The description's mentions of optional box-group filtering and the 5-region cap reinforce the schema but do not add new parameter-level meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly identifies the result as top regions ranked by blocked flows, cites the exact endpoint, and disambiguates scope with optional box group and the absence of a box-ID restriction. The noun-phrase style is still unambiguous because the endpoint and resource are explicit.

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

Usage Guidelines4/5

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

The description gives clear context: use this tool for regional blocked-flow statistics, optionally filtered by one box group, and it explicitly notes the query is not limited by FIREWALLA_BOX_ID. It does not name sibling alternatives like get_statistics_by_box, but the scope guidance is strong enough to route an agent correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.