Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_network_rules_summary

Read-only

Summarize Firewalla network rules by action, direction, status, and target type. Use it to view counts and rule distribution, optionally scoped to one box.

Instructions

Get overview counts of network rules by action, direction, status and target type (convenience wrapper): reads the rules from GET /v2/rules and counts them locally. Scoped to FIREWALLA_BOX_ID when set, otherwise every box.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoHow many rules to read for the summary (default: 200)
rule_typeNoSummarize only rules with this action (default: 'all')all
active_onlyNoLeave paused rules out of the summary (default: true)
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. Changed6 schema fields changedv2.0.1
    • changedInput schema / properties / active_only / description
      Previous value: -"Only include active rules in summary (default: true)"New value: +"Leave paused rules out of the summary (default: true)"
    • addedInput schema / properties / limit
      Added value: +{
+  "default": 200,
+  "description": "How many rules to read for the summary (default: 200)",
+  "maximum": 2000,
+  "minimum": 1,
+  "type": "number"
+}
    • 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"
+  ]
+}
    • addedInput schema / properties / rule_type / default
      Added value: +"all"
    • changedInput schema / properties / rule_type / description
      Previous value: -"Filter by rule type"New value: +"Summarize only rules with this action (default: 'all')"
    • addedInput schema / properties / rule_type / enum
      Added value: +[
+  "block",
+  "allow",
+  "timelimit",
+  "all"
+]
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safe-read profile (readOnlyHint=true, openWorldHint=true), and the description adds genuinely useful context beyond them: the counts are computed client-side from a rules read, which implies the summary is bounded by the limit parameter rather than a server-side aggregate. The scope rule for FIREWALLA_BOX_ID is also disclosed.

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?

Two sentences, output shape front-loaded, with the wrapper/implementation detail and scope following. No filler and nothing repeated from the schema.

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?

No output schema exists, so the description's enumeration of the counting dimensions is what tells the agent what comes back, and it does that adequately. It could say more about what the counts omit (e.g. rules beyond the limit) for a summary tool, but nothing essential is missing for correct invocation.

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%, including enum and default documentation for rule_type, active_only, limit, and response_format, so the schema carries the parameter burden. The description only adds the non-parameter FIREWALLA_BOX_ID scope note, so 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 overview counts of network rules') plus the grouping dimensions (action, direction, status, target type). The 'convenience wrapper' framing and the note that it reads GET /v2/rules and counts locally implicitly separates it from raw-rule siblings like get_network_rules and search_rules, though no sibling is named outright.

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 'convenience wrapper' phrasing and scope note ('Scoped to FIREWALLA_BOX_ID when set, otherwise every box') imply when the tool is appropriate, but it never says explicitly to prefer this over get_network_rules/search_rules when only counts are needed, nor when it is insufficient.

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