Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

pause_rule

Idempotent

Pause an active firewall rule immediately. Check its status first and skip if already paused to avoid unnecessary changes, holding it inactive until explicitly resumed.

Instructions

Pause an active firewall rule on the box until resume_rule reactivates it (POST /v2/rules/{id}/pause, no body). The MSP API takes no duration, so the pause does not expire on its own. Checks the rule's status first and changes nothing if it is already paused.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rule_idYesRule ID to pause

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.5.0
    • removedInput schema / properties / box
      Removed value: -{
-  "description": "Box GID for context (required by API)",
-  "type": "string"
-}
    • removedInput schema / properties / duration
      Removed value: -{
-  "default": 60,
-  "description": "Duration in minutes to pause the rule (optional, default: 60, range: 1-1440)",
-  "maximum": 1440,
-  "minimum": 1,
-  "type": "number"
-}
    • changedInput schema / required
      Previous value: -[
-  "rule_id",
-  "box"
-]New value: +[
+  "rule_id"
+]
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already include idempotentHint=true and destructiveHint=false, but the description adds significant context: the API takes no duration and the pause does not expire on its own, and it checks the rule's status first, changing nothing if already paused. This explains the idempotent behavior in detail and provides endpoint information, exceeding what annotations alone convey.

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?

Three sentences, all substantive: action, endpoint, no-duration behavior, and idempotency check. No filler or redundancy, and the core action is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter mutation tool with annotations covering safety and idempotency, the description includes the endpoint, no-duration constraint, and status check. It provides everything an agent needs to call it correctly, including when it is safe to invoke.

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% and the description does not add any meaning to the rule_id parameter beyond the schema's 'Rule ID to pause'. No additional constraints, format hints, or examples are provided, so it relies on the schema as expected.

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 description states a specific verb ('Pause') and resource ('active firewall rule'), and explicitly references 'resume_rule' as the counterpart, distinguishing it from sibling tools like search_rules. It is unambiguous about the tool's function.

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 mentions that the pause lasts until resume_rule reactivates it, which implies when to use the reverse tool, and notes that it checks status and does nothing if already paused, indicating safe calling conditions. However, it does not explicitly list alternatives or exclusions beyond resume_rule, so it's clear but not fully exhaustive.

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