Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_specific_alarm

Read-only

Retrieve full details of a specific Firewalla alarm by ID. Use to inspect individual security events and their context.

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
+}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses the multi-box scan behavior: without gid, 'each box is checked, one request per box, until one has the alarm.' This is a meaningful behavioral trait involving multiple HTTP requests and stop-at-first-match logic that annotations do not convey. No contradiction with annotations.

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, front-loaded with the action and endpoint, followed by the essential per-box ID caveat. No filler or redundant phrasing.

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 low-complexity read-only getter with full schema coverage and readOnlyHint, the description covers the endpoint and the only non-obvious behavior (multi-box lookup). It does not describe the return shape or not-found behavior, but there is no output schema and the operation is simple enough that this is a minor gap.

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 the baseline is 3. The description reinforces the per-box semantics of alarm IDs, but the input schema already documents the gid fallback and the aid source, so it adds little beyond what structured data already provides.

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 and resource: 'Get detailed information for one Firewalla alarm' plus the REST endpoint (GET /v2/alarms/{gid}/{aid}). This clearly differentiates it from sibling list tools like get_active_alarms and search_alarms by targeting a single alarm.

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?

The description gives clear context on when the tool is relevant and explains the gid/fallback behavior ('pass gid on a multi-box account, or each box is checked...'). It does not explicitly name alternatives or exclusions, but the schema notes that alarm_id comes from get_active_alarms or search_alarms, which is enough to route an agent from a list result to this details call.

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