Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_rule_trends

Read-only

Track daily rule creation trends over the last 30 days or selected period, scoped by box or group, to monitor Firewalla rule activity.

Instructions

Rules created per day for the last 30 days, one point per day, the last being today so far; period (default 30d) returns the days that overlap it. Without a box it is GET /v2/trends/rules covering every box, or the box group. When that endpoint answers 400 (it did when measured), each day counts the rules in GET /v2/rules created on it, on the days of GET /v2/trends/alarms (UTC days if that read fails): 3 requests, 4 with group. That endpoint takes no box, so with box (else FIREWALLA_BOX_ID, unless group is given) the rules of the box are counted that way: 2 requests. Rules deleted since are not counted, and the response says how the days were counted. box and group cannot be combined.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boxNoOnly rules of this box (box gid), counted from GET /v2/rules: 2 requests. Defaults to FIREWALLA_BOX_ID unless group is given; without either, every box. Not with group
groupNoGet trends for a specific box group. Takes precedence over FIREWALLA_BOX_ID; not with box
periodNoReturn the days that overlap this period (default: 30d). The API has no finer resolution than a day30d
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. Changed3 schema fields changedv2.0.1
    • addedInput schema / properties / box
      Added value: +{
+  "description": "Only rules of this box (box gid), counted from GET /v2/rules: 2 requests. Defaults to FIREWALLA_BOX_ID unless group is given; without either, every box. Not with group",
+  "type": "string"
+}
    • changedInput schema / properties / group / description
      Previous value: -"Get trends for a specific box group"New value: +"Get trends for a specific box group. Takes precedence over FIREWALLA_BOX_ID; not with box"
    • 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
    • addedInput schema / properties / period
      Added value: +{
+  "default": "30d",
+  "description": "Return the days that overlap this period (default: 30d). The API has no finer resolution than a day",
+  "enum": [
+    "1h",
+    "24h",
+    "7d",
+    "30d"
+  ],
+  "type": "string"
+}
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, and the description goes beyond them by disclosing that rules deleted since are not counted and that the response declares how the days were counted. It also notes the 400 fallback and per-call request cost, which helps an agent anticipate behavior, though it never describes the response shape directly.

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

Conciseness3/5

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

It is front-loaded with the purpose, but the body is a dense run-on chain of clauses about endpoints, status codes, and request counts that is hard to parse. Much of the mid-section reads as implementation notes rather than agent-facing guidance.

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 trends tool with no output schema, the description covers the counting semantics, fallback path, and the box/group mutual exclusion an agent needs to call it correctly. Remaining gaps are minor given the rich schema descriptions and annotations.

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 each parameter (box, group, period, response_format) is already fully documented in the schema, including the 'Not with group' constraint the description repeats. The description adds little parameter meaning beyond what the schema carries.

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 opening sentence states a specific verb+resource and the exact output granularity: 'Rules created per day for the last 30 days, one point per day, the last being today so far.' The resource (rules) clearly distinguishes it from siblings get_alarm_trends and get_flow_trends without opening any schema.

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 description details internal routing (box vs no box, endpoint fallback on 400, request counts) rather than when an agent should prefer this tool over get_alarm_trends or get_flow_trends. The constraint 'box and group cannot be combined' is genuinely useful, but usage is implied rather than framed as guidance.

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