Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_specific_alarm

Read-only

Retrieve full details for a specific Firewalla alarm by alarm ID; include the box gid on multi-box accounts or the server checks each box until found.

Instructions

Get detailed information for one Firewalla alarm (GET /v2/alarms/{gid}/{aid}). Alarm IDs are per box: pass gid on a multi-box account, or each box is checked, one request per box, until one has the alarm.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gidNoBox the alarm belongs to (the gid field of get_active_alarms or search_alarms results). Defaults to FIREWALLA_BOX_ID; without either, each box on the account is checked.
alarm_idYesAlarm ID (required for API call): the aid from get_active_alarms or search_alarms, as a number or a string
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. Changed1 schema field changedv2.0.1
    • 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. Changed3 schema fields changedv1.5.0
    • changedInput schema / properties / alarm_id / description
      Previous value: -"Alarm ID (required for API call)"New value: +"Alarm ID (required for API call): the aid from get_active_alarms or search_alarms, as a number or a string"
    • changedInput schema / properties / alarm_id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number"
+]
    • addedInput schema / properties / gid
      Added value: +{
+  "description": "Box the alarm belongs to (the gid field of get_active_alarms or search_alarms results). Defaults to FIREWALLA_BOX_ID; without either, each box on the account is checked.",
+  "type": "string"
+}
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered; the description adds real value beyond that by disclosing the fan-out behavior (one request per box until a match is found) on multi-box accounts. It omits rate-limit or auth details, which keeps it short of a 5.

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 tight sentences, front-loaded with the purpose and endpoint before the multi-box caveat. 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?

With no output schema the description should ideally say what the alarm payload contains, but for a single-record fetch whose annotations already flag it read-only and open-world, the multi-box retrieval mechanics and ID sourcing cover what an agent needs to invoke it correctly.

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 coverage is 100%, so the baseline is 3, but the description adds meaning the schema alone does not convey: that alarm IDs are scoped per box and that gid should come from get_active_alarms or search_alarms results. That is genuine added semantic context.

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?

States a specific verb+resource ('Get detailed information for one Firewalla alarm') and pins it to the exact endpoint GET /v2/alarms/{gid}/{aid}, making it clearly distinct from the list-oriented siblings get_active_alarms and search_alarms.

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?

Explains the operational context: pass gid on multi-box accounts, and that alarm IDs are per box so each box may be checked until one has the alarm. It does not explicitly name search_alarms as the alternative for finding an aid, but the required-parameter flow implies it.

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