Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_alarm_trends

Read-only

Track daily alarm counts across all boxes, a group, or one box over 30 days to spot security trends.

Instructions

Alarms generated 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 one GET /v2/trends/alarms covering every box, or the box group. That endpoint takes no box, so with box (else FIREWALLA_BOX_ID, unless group is given) each day is counted with one GET /v2/alarms groupBy=box scoped to the box: 1 request plus 1 per day, ~31 for 30d, of the 100 requests the API allows per 5 minutes. box and group cannot be combined.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boxNoOnly alarms of this box (box gid), counted per day: 1 request plus 1 per day (~31 for 30d). 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 day, so 1h returns today so far and 24h returns yesterday and today30d
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 alarms of this box (box gid), counted per day: 1 request plus 1 per day (~31 for 30d). 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, so 1h returns today so far and 24h returns yesterday and today",
+  "enum": [
+    "1h",
+    "24h",
+    "7d",
+    "30d"
+  ],
+  "type": "string"
+}
  3. First observed

TDQS

A4/5.0
Behavior5/5

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

With annotations covering only readOnlyHint and openWorldHint, the description adds substantive operational context: the exact request cost (1 + 1 per day, ~31 for 30d), the 100-requests-per-5-minutes budget it consumes, and the fact that the no-box endpoint differs in behavior. This is exactly the kind of cost/rate-limit disclosure an agent needs before calling.

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?

Front-loaded with the core output shape, but it devolves into a dense run-on sentence that mixes request accounting and parameter rules, and duplicates the schema's per-parameter wording. Reasonably sized for the complexity, but the structure makes it hard to parse.

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, but the description conveys the return shape (one point per day) and the markdown/response_format view, plus cost and rate-limit context. Sufficient for correct invocation, though a note on what trend values represent would round it out.

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%, so the baseline is 3. The body text largely restates what the parameter descriptions already say (box/group precedence, no combination, period overlap), adding little semantic value beyond the schema.

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 opening states a specific verb and resource with granularity: alarms counted per day over the last 30 days, one point per day. This clearly separates it from search_alarms/get_active_alarms (filtering) and aligns it with the *trends family. It never names a sibling, so differentiation is inferred rather than stated.

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?

Gives explicit conditional logic for box vs group vs neither, including precedence (FIREWALLA_BOX_ID unless group is given) and the constraint that box and group cannot be combined. It does not, however, say when to prefer this tool over search_alarms or get_statistics_by_box, so no exclusion/alternative 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