Skip to main content
Glama

Search Firewalla Flows

firewalla_search_flows
Read-onlyIdempotent

Search and analyze network traffic flows to monitor activity, identify security issues, and audit blocked or allowed connections using Firewalla's query grammar.

Instructions

Search network flows observed by Firewalla with the MSP query grammar. Use this to inspect what's actually happening on the wire.

Use this to answer:

  • "Any outbound flows to region:CN that were NOT blocked?"

  • "Top talkers by download volume over the last 24h?"

  • "Which devices have made the most connections to blocklisted categories?"

  • "Are there any inbound flows from the public internet that shouldn't exist?"

  • "Flows from device X in the last hour?"

Args:

  • query (string, optional): Firewalla query grammar. Examples: blocked:true, region:CN, direction:inbound, device.mac:AA:BB:CC:DD:EE:FF, category:malware, ts:>1700000000, combined with AND/OR.

  • group_by (string, optional): e.g. device, device,destination, region.

  • sort_by (string, optional): e.g. ts:desc (default), download:desc.

  • limit (number, 1–500, default 200).

  • cursor (string, optional): pagination cursor from a prior response.

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, // items in this page next_cursor?: string, flows: Array<{ ts, gid, protocol, direction, block?, blockType?, download?, upload?, total?, duration?, count?, device?: { id, ip?, name?, network? }, source?: { id?, ip?, name?, port? }, destination?: { id?, ip?, name?, port? }, // Flow-level classification fields (NOT nested under destination): country?, region?, domain?, category? }> }

Audit framing:

  • Start broad with sort_by=download:desc to find top bandwidth users.

  • Narrow with query when you've found a device/region of interest.

  • block=false flows to a category:malware destination = missed block, investigate rules.

  • Use group_by for aggregates; use limit=50 or so for fine-grained review.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoFirewalla query string (pass-through). See Firewalla docs for the grammar — supports filters like `device.mac:AA:BB:CC:DD:EE:FF`, `blocked:true`, `region:CN`, `ts:>1700000000`, etc. Omit to match everything.
group_byNoGroup results by one or more fields (comma-separated). Examples: `device`, `device,domain`, `region`. When set, results are aggregated per group.
sort_byNoSort expression. Format: `<field>:<asc|desc>`. Common: `ts:desc` (default, newest first), `ts:asc` (oldest first), `download:desc` (biggest flows first).
limitNoMaximum results per page (1–500, default 200). Smaller values are recommended when auditing — easier to review.
cursorNoPagination cursor echoed from a prior response's `next_cursor`. Omit for the first page.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, covering safety and idempotency. The description adds valuable behavioral context beyond annotations: it explains the tool's primary use for audit/inspection ('inspect what's actually happening on the wire'), provides strategic guidance in the 'Audit framing' section, and hints at typical workflows (e.g., 'Start broad... Narrow with query'). It doesn't mention rate limits or authentication needs, but adds meaningful operational context.

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?

The description is well-structured with clear sections: purpose statement, usage examples, parameter details, return format, and audit guidance. Every sentence adds value, though it's somewhat lengthy (which is justified given the tool's complexity). The information is front-loaded with the core purpose and usage examples immediately visible.

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 complex search tool with 6 parameters and no output schema, the description provides exceptional completeness. It includes: clear purpose, specific usage examples, detailed parameter explanations with examples, return format documentation, and strategic audit guidance. The combination of thorough parameter coverage in the schema and rich contextual information in the description makes this fully self-contained for an AI agent.

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 description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds value by providing concrete query examples in the 'Args' section (e.g., 'blocked:true', 'region:CN', 'device.mac:AA:BB:CC:DD:EE:FF') and explaining the purpose of each parameter in context. It also clarifies the relationship between parameters in the 'Audit framing' section (e.g., 'Use group_by for aggregates; use limit=50 or so for fine-grained review').

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?

The description explicitly states the tool's purpose: 'Search network flows observed by Firewalla with the MSP query grammar. Use this to inspect what's actually happening on the wire.' It clearly distinguishes this from sibling tools like firewalla_get_alarm or firewalla_list_devices by focusing on flow inspection rather than alarms, devices, or rules.

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

Usage Guidelines5/5

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

The description provides explicit guidance on when to use this tool through the 'Use this to answer' section with five concrete examples (e.g., 'Any outbound flows to region:CN that were NOT blocked?', 'Top talkers by download volume over the last 24h?'). The 'Audit framing' section offers strategic advice on starting broad and narrowing down, plus specific use cases like investigating missed blocks.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/productengineered/firewalla-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server