Skip to main content
Glama

firewalla-mcp-server

一个只读Model Context Protocol (MCP) 服务器,让 Claude 可以通过 Firewalla MSP API 审计您的 Firewalla 配置和网络安全态势。

设计为只读。 此服务器无法阻止/解除阻止设备、创建或修改规则、暂停服务或对您的 Firewalla 进行任何更改。它仅用于观察。

功能介绍

提供了 8 个工具,Claude 可以使用这些工具来检查您的 Firewalla — 包括网络上的设备、活动规则、安全警报、网络流以及阻止/允许目标列表。

Related MCP server: mcp-infra-readonly

提示词示例

安全审计

这些提示词将 Claude 视为一名网络安全专家,对您的 Firewalla 配置进行结构化审查。它们在 Claude Desktop 或 Claude Code 中效果最佳,因为这些环境可以使用 Firewalla MCP 工具。

全网安全审计:

你是一位高级网络安全工程师,正在对我的家庭网络进行全面审计。使用 Firewalla MCP 工具,执行以下审查并以结构化报告的形式呈现你的发现,并附上严重性评级(严重 / 高 / 中 / 低 / 信息):

  1. 设备清单 — 拉取完整的设备列表。标记任何具有无法识别的 MAC 厂商的设备、未被监控的设备,或可能表明存在非法接入点的意外路由器类设备。

  2. 规则审计 — 审查所有阻止/允许规则。识别任何过于宽松的允许规则(范围过广、入站方向、无设备限制)。标记命中次数为零且可能已过期的规则。

  3. 警报审查 — 按类型和严重性对最近的警报进行分组搜索。识别任何模式(来自同一设备的重复警报、来自意外国家的警报、针对不应有外部暴露的设备的警报)。

  4. 目标列表覆盖范围 — 审查哪些阻止列表处于活动状态。评估当前的列表配置是否针对常见的威胁类别(恶意软件、C2、网络钓鱼、加密货币挖矿、新注册域名)提供了足够的覆盖范围。

最后,列出一份我应该采取的优先行动清单,以改善我的网络安全态势。

防火墙规则差距分析:

扮演防火墙策略分析师的角色。拉取我所有的 Firewalla 规则和完整的设备列表,然后进行交叉引用。我需要你识别:(1) 完全没有任何规则作用于其上的设备 — 它们是否完全依赖全局规则,这是否是有意的?(2) 授予入站访问权限的允许规则 — 它们针对哪些设备,范围是否足够窄?(3) 从未触发过的阻止规则(命中次数 = 0) — 它们是过期的,还是它们所防范的威胁根本不存在?请以表格形式为每个类别呈现你的发现,并附上你的评估和建议行动。

可疑流量调查:

我想调查我的网络上是否有任何设备正在与意外的外部目的地通信。搜索我最近的网络流,查找任何未被 Firewalla 阻止的流向美国以外地区的流量。按设备和目的地国家/地区对结果进行分组。对于任何显示有未被阻止的流向异常地区流量的设备,将其与我的设备列表进行交叉引用以识别该设备是什么,然后检查是否有任何与之相关的警报。总结你的发现,并为每个被标记的设备提供风险评估。

快速查询

这些是用于日常监控和抽查的简短提示词:

  • “列出我网络上的所有设备,并标记任何具有未知 MAC 厂商或未被 Firewalla 监控的设备。”

  • “向我展示我 Firewalla 上的所有允许规则。它们中是否有范围太广的?”

  • “目前我网络上触发最多的警报类型是什么?按类型分组并给出计数。”

  • “检查我激活了哪些 Firewalla 阻止列表,以及每个列表有多少条目。我是否遗漏了任何重要的类别?”

  • “搜索过去 24 小时内任何被阻止的流量,并按目的地国家/地区进行分组。哪些国家/地区出现的频率最高?”

  • “拉取我的 Firewalla 盒子信息 — 它是否在线,运行的是什么固件版本,目前有多少活动警报?”

工具

工具

描述

firewalla_list_boxes

发现 MSP 账户上的 Firewalla 盒子(型号、固件、在线状态、设备/规则/警报计数)

firewalla_list_devices

清点网络上的所有设备(IP、MAC 厂商、设备类型、在线状态、监控标志)

firewalla_search_flows

使用查询过滤器、分组和游标分页搜索网络流

firewalla_search_alarms

使用查询过滤器、分组和游标分页搜索活动安全警报

firewalla_get_alarm

通过盒子 + 警报 ID 获取单个警报的完整详细信息

firewalla_list_rules

审计配置的阻止/允许规则(动作、方向、目标、范围、命中次数)

firewalla_list_target_lists

列出阻止/允许目标列表(Firewalla 管理的和用户定义的)

firewalla_get_target_list

通过 ID 获取单个目标列表的元数据

所有工具都支持 response_format: "json" | "markdown" 并且被标注为 readOnlyHint: true

先决条件

  1. 一个 Firewalla 盒子,链接到 MSP 账户。即使是独立(非集群)盒子也使用 MSP API — 这是唯一支持的公共 API。

  2. 一个 MSP 个人访问令牌。 在以下位置生成一个:

    • 登录您的 MSP 门户 https://<your-subdomain>.firewalla.net

    • 转到 Account SettingsPersonal Access Tokens

    • 创建一个新令牌并将其保存在安全的地方

    有关详细的设置说明,请参阅 Getting Started with the Firewalla MSP API

  3. Node.js 18+

安装

git clone https://github.com/productengineered/firewalla-mcp.git
cd firewalla-mcp
npm install
npm run build

配置

服务器读取两个环境变量:

变量

描述

示例

FIREWALLA_MSP_DOMAIN

您的 MSP 子域名(无 https://,无尾随斜杠)

yourname.firewalla.net

FIREWALLA_MSP_TOKEN

来自 MSP 账户设置的个人访问令牌

fwtoken_abc123...

对于本地开发,将 .env.example 复制到 .env 并填入您的值:

cp .env.example .env
# edit .env with your real values

与 Claude Desktop 一起使用

添加到您的 claude_desktop_config.json(在 macOS 上通常位于 ~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "firewalla": {
      "command": "node",
      "args": ["/absolute/path/to/firewalla-mcp/dist/index.js"],
      "env": {
        "FIREWALLA_MSP_DOMAIN": "yourname.firewalla.net",
        "FIREWALLA_MSP_TOKEN": "your-token-here"
      }
    }
  }
}

注意: Claude Desktop 启动时使用最小化的 PATH。如果找不到 node,请使用 Node.js 二进制文件的绝对路径(例如 which node 的输出)。

编辑配置后重启 Claude Desktop。

与 Claude Code 一起使用

claude mcp add-json --scope user firewalla '{
  "type": "stdio",
  "command": "node",
  "args": ["/absolute/path/to/firewalla-mcp/dist/index.js"],
  "env": {
    "FIREWALLA_MSP_DOMAIN": "yourname.firewalla.net",
    "FIREWALLA_MSP_TOKEN": "your-token-here"
  }
}'

验证:

claude mcp list
# firewalla: ... - ✓ Connected

新的 Claude Code 会话将自动拥有 firewalla_* 工具。

开发

# Source env for local dev
set -a; source .env; set +a

# Run with auto-reload
npm run dev

# Build
npm run build

# Test with MCP Inspector
npx @modelcontextprotocol/inspector --cli node dist/index.js --method tools/list

Firewalla API 文档

许可证

MIT

Available Tools

8 tools
firewalla_get_alarmGet Firewalla AlarmA
Read-onlyIdempotent

Fetch the full detail of a single alarm by gid (box id) + aid (alarm id). Use this after firewalla_search_alarms to drill into one event.

Args:

  • gid (string, required): Box id (from firewalla_list_boxes).

  • aid (string, required): Alarm id (from firewalla_search_alarms).

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns the full alarm record, which may include device, remote endpoint, category, timestamps, and any alarm-type-specific detail fields the MSP API surfaces.

ParametersJSON Schema
NameRequiredDescriptionDefault
gidYesBox id (from firewalla_list_boxes).
aidYesAlarm id (from firewalla_search_alarms results). Accepts number or string; the API returns numeric ids.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.5/5.0
Behavior4/5

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

The annotations already provide comprehensive behavioral hints (readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true). The description adds valuable context beyond annotations by explaining the purpose of the response_format parameter ('markdown renders human-readable audit tables; json returns structured data suitable for chaining') and describing what the return contains ('full alarm record... may include device, remote endpoint, category, timestamps, and alarm-type-specific detail fields').

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?

The description is perfectly structured with a clear purpose statement upfront, followed by a usage guideline, then parameter context in a formatted Args section, and finally return value information. Every sentence serves a distinct purpose with zero redundancy or wasted words.

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 read-only tool with comprehensive annotations and full schema coverage, the description provides excellent contextual completeness. It explains the tool's role in the workflow, clarifies parameter sources, describes output format implications, and outlines what information the alarm record contains - all without needing to duplicate what's already in structured fields.

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 schema already fully documents all parameters. The description adds minimal additional semantic context beyond the schema - it mentions that aid comes from firewalla_search_alarms results (already in schema) and explains the practical implications of response_format choices. This meets the baseline expectation when schema coverage is complete.

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 clearly states the specific action ('Fetch the full detail of a single alarm') and identifies the required resources (gid and aid). It explicitly distinguishes this tool from its sibling firewalla_search_alarms by stating 'Use this after firewalla_search_alarms to drill into one event,' establishing a clear relationship and differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool ('Use this after firewalla_search_alarms to drill into one event') and references prerequisite tools for obtaining required parameters (firewalla_list_boxes for gid, firewalla_search_alarms for aid). This creates a clear workflow context and distinguishes it from other siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_get_target_listGet Firewalla Target ListA
Read-onlyIdempotent

Fetch the metadata for a single target list by id.

MSP API limitation: For Firewalla-managed lists (owner="firewalla"), the MSP API does NOT return individual target entries — it returns the summary plus the aggregate count. User-created lists may include a targets array; if so, we surface it.

Use this to answer:

  • "What's the block mode / source / type of list X?"

  • "When was list X last updated?"

  • "How big is list X?" (use the count / targetCount field)

Do NOT use this to answer:

  • "Is domain example.com on list X?" — the entries aren't returned.

  • "Give me the first N entries of list X." — same reason.

Args:

  • id (string, required): Target-list id (from firewalla_list_target_lists).

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { id, name, owner, type?, source?, blockMode?, notes?, lastUpdated?, count?: number, // summary count reported by the API targetCount: number, // same as count, or actual targets.length when present targets?: string[] // only populated for user-created lists (rare) }

ParametersJSON Schema
NameRequiredDescriptionDefault
idYesTarget-list id (from firewalla_list_target_lists).
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, covering safety and idempotency. The description adds valuable context beyond this: it discloses the MSP API limitation for Firewalla-managed lists (no individual entries returned), clarifies when targets array is populated (user-created lists), and explains the difference between count and targetCount fields. No contradictions with annotations exist.

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?

The description is well-structured and front-loaded with the core purpose. It uses bullet points for usage guidelines, separates arguments and returns clearly, and avoids redundant information. Every sentence adds value, such as explaining API limitations and field meanings.

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?

Given the tool's moderate complexity (fetching metadata with API limitations), the description is complete. It covers purpose, usage, behavioral nuances (like API constraints), parameters, and return structure in detail. Although there's no output schema, the description provides a comprehensive return object specification, compensating adequately.

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%, with clear descriptions for both parameters (id and response_format). The description adds minimal extra semantics: it reiterates that id comes from firewalla_list_target_lists (already in schema) and briefly explains response_format options (default and use cases). This meets the baseline for high schema coverage without significant added value.

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 explicitly states the verb 'fetch' and resource 'metadata for a single target list by id', making the purpose specific. It distinguishes from sibling tools like firewalla_list_target_lists by focusing on a single list rather than listing all, and clarifies limitations compared to potential expectations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool (e.g., to answer questions about block mode, source, type, last updated, or size) and when not to use it (e.g., to check if a domain is on the list or get entries). It also references the sibling tool firewalla_list_target_lists for obtaining the id parameter.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_list_boxesList Firewalla BoxesA
Read-onlyIdempotent

Discover the Firewalla boxes linked to this MSP account. This is the entry point for every audit — the returned gid is required by other tools.

Use this to answer:

  • "Is my box online and reporting in?"

  • "What firmware version is it running?"

  • "How many active devices, rules, alarms are there right now?"

Args:

  • group (string, optional): Filter to a specific group id.

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, boxes: Array<{ gid: string, // box id — save this, other tools need it name: string, model: string, // e.g. "gold_plus" mode: string, // routing mode version: string, // firmware online: boolean, publicIP?: string, lastSeen?: number, // epoch seconds — not always populated license?: string, location?: string, deviceCount: number, ruleCount: number, alarmCount: number, // currently-active alarms group?: { id, name } }> }

Audit framing:

  • Offline box → can't observe current state; surface it.

  • High alarmCount → follow up with firewalla_search_alarms.

  • publicIP exposed unexpectedly → investigate with firewalla_search_flows.

ParametersJSON Schema
NameRequiredDescriptionDefault
groupNoFilter to boxes in a specific group id. Omit to list all boxes on the account.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, covering the safety profile. The description adds valuable behavioral context beyond annotations: it explains the audit framing logic, clarifies that 'lastSeen' is 'not always populated', and provides guidance on interpreting results and next steps based on findings like offline boxes or high alarm counts.

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

Conciseness4/5

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

The description is well-structured with clear sections (purpose, usage questions, Args, Returns, audit framing) and efficiently conveys necessary information. While comprehensive, every section earns its place by adding value, though the Args section could be more concise given the schema coverage.

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?

Given the tool's complexity as an audit entry point with rich return data and sibling relationships, the description provides complete context. It explains the tool's role in the ecosystem, provides detailed return structure documentation (compensating for no output schema), and includes audit framing that guides interpretation and next steps with sibling tools.

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%, with both parameters well-documented in the schema. The description's Args section essentially repeats what's in the schema without adding significant semantic context beyond what's already structured. The baseline of 3 is appropriate when the schema does the heavy lifting for parameter documentation.

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 clearly states the specific action ('Discover'), resource ('Firewalla boxes linked to this MSP account'), and scope ('entry point for every audit'). It distinguishes from siblings by emphasizing this tool provides the essential 'gid' needed by other tools, unlike more specific tools like firewalla_search_alarms or firewalla_list_devices.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool ('entry point for every audit'), when to follow up with alternatives ('High alarmCount → follow up with firewalla_search_alarms', 'publicIP exposed unexpectedly → investigate with firewalla_search_flows'), and includes audit framing questions that guide appropriate usage scenarios.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_list_devicesList Firewalla DevicesA
Read-onlyIdempotent

Inventory every device Firewalla tracks — the "who's on my network right now" primitive.

Use this to answer:

  • "Are there any unknown/rogue devices on my network?"

  • "Which devices aren't being monitored?"

  • "What's the MAC vendor breakdown across my network?"

  • "Any router-class devices I didn't expect?"

Args:

  • box (string, optional): Filter to devices on a specific box gid.

  • online_only (boolean, optional): Drop offline devices client-side.

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, // devices after client-side filtering total: number, // devices returned by the API (pre-filter) devices: Array<{ id: string, // typically MAC gid: string, // box the device is attached to name: string, ip: string, mac?: string, macVendor?: string, ipReserved?: boolean, online: boolean, network?: { id, name }, deviceType?: string, // e.g. "phone", "computer", "iot" isRouter?: boolean, isFirewalla?: boolean, monitoring?: boolean, // false = device excluded from monitoring totalDownload?: number, // bytes (lifetime) totalUpload?: number }> }

Audit framing:

  • Unknown macVendor → possible squatter or spoofed MAC.

  • monitoring=false → device is excluded from Firewalla's visibility; review whether that's intentional.

  • Unexpected isRouter=true → shadow router on the LAN.

  • ipReserved=false on a server that should have a static lease → risk of address drift.

ParametersJSON Schema
NameRequiredDescriptionDefault
boxNoFilter to devices attached to a specific box gid.
online_onlyNoIf true, drop offline devices from the response. Client-side filter — the API returns all devices either way.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already provide readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, covering safety and idempotency. The description adds valuable behavioral context about client-side filtering ('online_only' drops offline devices client-side), output format implications, and audit interpretations that help the agent understand how to process and interpret results beyond basic safety information.

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

Conciseness4/5

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

The description is well-structured with clear sections (purpose, usage questions, args, returns, audit framing) and every sentence adds value. While somewhat lengthy, it's efficiently organized with bullet points and structured returns documentation, making it easy to parse. Minor deduction for being slightly verbose in the returns section.

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?

Given the tool's complexity and the absence of an output schema, the description provides comprehensive context including detailed return structure documentation, audit interpretation guidance, and clear usage scenarios. With annotations covering safety aspects and the description filling in behavioral and interpretive gaps, this provides complete context for the agent to effectively use this tool.

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 schema already fully documents all three parameters. The description adds minimal additional context beyond what's in the schema (e.g., 'client-side filter' for online_only, output format implications), but doesn't provide significant semantic value beyond the structured documentation. Baseline 3 is appropriate given complete schema coverage.

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 clearly states the tool's purpose as 'Inventory every device Firewalla tracks' and positions it as the 'who's on my network right now' primitive. It distinguishes from siblings by focusing on device inventory rather than alarms, rules, flows, or boxes, making the scope specific and differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage scenarios with bullet points answering specific questions like 'Are there any unknown/rogue devices on my network?' and 'Which devices aren't being monitored?'. It also includes an 'Audit framing' section that guides interpretation of results, effectively telling the agent when and how to use this tool for network auditing purposes.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_list_rulesList Firewalla RulesA
Read-onlyIdempotent

Audit configured block / allow rules. Read-only — this tool does NOT pause, resume, create, or modify rules.

Use this to answer:

  • "Do I have any allow rules that bypass Firewalla's default blocks?"

  • "Which rules haven't fired in 90 days (candidates to remove)?"

  • "Are my block rules scoped to the right device/group?"

  • "Any rules with action=allow and broad scope?"

Args:

  • query (string, optional): Firewalla query-grammar filter (pass-through). Examples: action:allow, status:paused, target.type:domain.

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, rules: Array<{ id: string, gid: string, action: string, // "block" | "allow" | "time_limit" | … direction?: string, // "outbound" | "inbound" | "bidirection" status?: string, // "active" | "paused" | "disabled" target: { type, value, dnsOnly?, port? }, scope?: { type?, value? }, notes?: string, hit?: { count?, lastHitTs? }, ts?: number, updateTs?: number }> }

Audit framing:

  • action=allow with scope=global → overly permissive, investigate.

  • status=paused with no notes → someone disabled a rule and didn't document why.

  • hit.count=0 & old updateTs → stale rule, candidate for removal.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryNoFirewalla query string (pass-through). See Firewalla docs for the grammar — supports filters like `device.mac:AA:BB:CC:DD:EE:FF`, `blocked:true`, `region:CN`, `ts:>1700000000`, etc. Omit to match everything.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.7/5.0
Behavior4/5

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

The description adds valuable behavioral context beyond the annotations. While annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, the description adds the 'audit framing' section that explains how to interpret the results for security analysis. This provides practical guidance on what patterns to look for in the returned data.

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?

The description is exceptionally well-structured and front-loaded. The first sentence establishes the core purpose, followed immediately by usage examples, parameter details, return format, and audit guidance. Every section serves a distinct purpose with zero wasted text, making it easy for an AI agent to parse and understand.

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?

Given the comprehensive annotations, detailed input schema with 100% coverage, and the rich description that includes usage examples, parameter context, return format explanation, and audit guidance, this description provides complete context for a read-only audit tool. The absence of an output schema is compensated by the detailed return structure documentation in the description.

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?

With 100% schema description coverage, the baseline would be 3. However, the description adds meaningful context by providing example queries in the 'Use this to answer' section that illustrate practical applications of the query parameter. The audit framing section also helps users understand how to interpret results based on parameter combinations.

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 clearly states the tool's purpose with specific verbs ('audit configured block/allow rules') and distinguishes it from siblings by explicitly stating what it does NOT do ('does NOT pause, resume, create, or modify rules'). This makes it immediately clear this is a read-only audit tool versus other Firewalla tools that might modify rules.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides excellent usage guidance with four specific example questions this tool can answer, giving concrete scenarios for when to use it. It also explicitly distinguishes from alternatives by stating what it doesn't do, helping users understand when NOT to use this tool versus modification tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_list_target_listsList Firewalla Target ListsA
Read-onlyIdempotent

List the block/allow target lists available on this MSP account — both Firewalla-managed ("global") and user-defined.

Use this to answer:

  • "Which block lists is Firewalla enforcing against?"

  • "Have I added any custom target lists, and what are their owners?"

  • "What categories (ad, tracker, malware, …) are covered?"

This endpoint returns summaries (including target count per list); call firewalla_get_target_list for the actual targets array.

Args:

  • owner (string, optional): Filter by owner (e.g. 'global').

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, // number of target lists targetLists: Array<{ id: string, name: string, owner: string, // "global" | user id type?: string, // e.g. "ad", "tracker", "malware", "custom" source?: string, // upstream feed source (Firewalla-managed lists) count?: number, // number of entries in the list blockMode?: string, // e.g. "dns" | "ip" beta?: boolean, notes?: string, lastUpdated?: number }> }

Audit framing:

  • Custom lists (owner != global) without notes → undocumented intent.

  • blockMode=dns only, but target includes raw IPs → mismatch, investigate.

  • Zero-count list → may be stale / never populated.

ParametersJSON Schema
NameRequiredDescriptionDefault
ownerNoFilter by owner. Common values: 'global' (Firewalla-managed), or a specific user id. Omit to list all.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already provide readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds valuable context beyond this: it explains the distinction between summaries vs. detailed targets, provides audit framing guidance (e.g., 'Custom lists without notes → undocumented intent'), and mentions output format implications. While it doesn't cover rate limits or authentication needs, it adds significant behavioral context beyond the 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?

The description is efficiently structured: it starts with the core purpose, provides usage examples in bullet points, explains the relationship with a sibling tool, documents parameters and returns, and ends with audit framing. Every sentence serves a clear purpose with zero waste, and information is front-loaded appropriately.

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?

Given the tool's moderate complexity, rich annotations (readOnly, idempotent, openWorld), and 100% schema coverage, the description is complete. It explains the tool's purpose, usage guidelines, relationship with siblings, parameter semantics (though schema covers this), return structure, and even includes audit framing for interpretation. No output schema exists, but the description thoroughly documents the return format.

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 schema already fully documents both parameters. The description adds minimal value beyond the schema: it mentions the 'owner' filter can be used to list all (implied by omission) and provides example values, but doesn't add substantial semantic context. This meets the baseline of 3 when schema coverage is high.

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 clearly states the verb ('List') and resource ('block/allow target lists available on this MSP account'), specifying both Firewalla-managed ('global') and user-defined lists. It distinguishes this tool from its sibling 'firewalla_get_target_list' by noting that this returns summaries while the sibling provides the actual targets array.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly provides three example questions this tool can answer, giving clear context for when to use it. It also distinguishes from the sibling 'firewalla_get_target_list' by stating this returns summaries while that tool provides the actual targets array, offering explicit guidance on alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_search_alarmsSearch Firewalla AlarmsA
Read-onlyIdempotent

Search active Firewalla alarms with the MSP query grammar. This is the primary tool for "what security events are happening right now?" audits.

Use this to answer:

  • "Any alarms from devices not in a known group?"

  • "How many alarms of type X in the last 24h, grouped by device?"

  • "Which remote countries are triggering the most alarms?"

  • "Any alarms relating to a specific device (by MAC)?"

Args:

  • query (string, optional): Firewalla query grammar. Examples: type:1, device.mac:AA:BB:CC:DD:EE:FF, remote.country:CN, ts:>1700000000.

  • group_by (string, optional): e.g. device, type, remote.country.

  • sort_by (string, optional): e.g. ts:desc (default), ts:asc.

  • limit (number, 1–500, default 200).

  • cursor (string, optional): pagination cursor from a prior response.

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, // items in this page next_cursor?: string, // echo back to fetch the next page alarms: Array<{ aid, gid, type, ts, message, status?, device?: { id?, name?, ip? }, remote?: { ip?, country?, name?, region?, category? } }> }

Audit framing:

  • Alarm from an unknown MAC (device.id not in firewalla_list_devices) → rogue device.

  • Repeated alarms to the same remote.country → likely a single piece of malware, check firewalla_list_rules.

  • When counts get big, use group_by=type first for a birds-eye view, then drill.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryNoFirewalla query string (pass-through). See Firewalla docs for the grammar — supports filters like `device.mac:AA:BB:CC:DD:EE:FF`, `blocked:true`, `region:CN`, `ts:>1700000000`, etc. Omit to match everything.
group_byNoGroup results by one or more fields (comma-separated). Examples: `device`, `device,domain`, `region`. When set, results are aggregated per group.
sort_byNoSort expression. Format: `<field>:<asc|desc>`. Common: `ts:desc` (default, newest first), `ts:asc` (oldest first), `download:desc` (biggest flows first).
limitNoMaximum results per page (1–500, default 200). Smaller values are recommended when auditing — easier to review.
cursorNoPagination cursor echoed from a prior response's `next_cursor`. Omit for the first page.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.7/5.0
Behavior4/5

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

While annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, the description adds valuable behavioral context beyond these annotations. It explains the tool's role in security audits, provides guidance on handling large result sets ('When counts get big, use group_by=type first'), and describes pagination behavior through the cursor parameter. The description doesn't contradict annotations and adds meaningful operational context.

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?

The description is efficiently structured with clear sections: purpose statement, usage examples, parameter details, return format, and audit guidance. Every sentence serves a specific purpose—no wasted words. The information is front-loaded with the core purpose, followed by progressively detailed guidance. The structure supports both quick understanding and deep reference.

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?

Given the tool's complexity (6 parameters, security audit focus) and the absence of an output schema, the description provides excellent contextual completeness. It fully documents the return structure in the 'Returns' section, explains pagination mechanics, provides audit-specific guidance, and references sibling tools for follow-up actions. The description compensates fully for the lack of output schema and provides comprehensive operational context.

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?

With 100% schema description coverage, the baseline would be 3, but the description adds significant value beyond the schema. The 'Args' section provides concrete query examples (`type:1`, `device.mac:AA:BB:CC:DD:EE:FF`, etc.) that illustrate the query grammar more vividly than the schema's description. It also explains the practical implications of parameters like 'group_by' for aggregation and 'response_format' for different use cases (human-readable vs. chaining).

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 explicitly states the tool's purpose as 'Search active Firewalla alarms with the MSP query grammar' and positions it as 'the primary tool for "what security events are happening right now?" audits.' This clearly distinguishes it from sibling tools like firewalla_get_alarm (likely for single alarm retrieval) and firewalla_search_flows (for flow data rather than alarms), providing specific verb+resource+scope differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool through concrete example questions ('Any alarms from devices not in a known group?', 'How many alarms of type X in the last 24h, grouped by device?', etc.) and includes an 'Audit framing' section with specific scenarios (e.g., 'Alarm from an unknown MAC → rogue device'). It also implicitly suggests alternatives by referencing sibling tools like firewalla_list_devices and firewalla_list_rules for follow-up actions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

firewalla_search_flowsSearch Firewalla FlowsA
Read-onlyIdempotent

Search network flows observed by Firewalla with the MSP query grammar. Use this to inspect what's actually happening on the wire.

Use this to answer:

  • "Any outbound flows to region:CN that were NOT blocked?"

  • "Top talkers by download volume over the last 24h?"

  • "Which devices have made the most connections to blocklisted categories?"

  • "Are there any inbound flows from the public internet that shouldn't exist?"

  • "Flows from device X in the last hour?"

Args:

  • query (string, optional): Firewalla query grammar. Examples: blocked:true, region:CN, direction:inbound, device.mac:AA:BB:CC:DD:EE:FF, category:malware, ts:>1700000000, combined with AND/OR.

  • group_by (string, optional): e.g. device, device,destination, region.

  • sort_by (string, optional): e.g. ts:desc (default), download:desc.

  • limit (number, 1–500, default 200).

  • cursor (string, optional): pagination cursor from a prior response.

  • response_format ('markdown' | 'json'): Output format (default: markdown).

Returns: { count: number, // items in this page next_cursor?: string, flows: Array<{ ts, gid, protocol, direction, block?, blockType?, download?, upload?, total?, duration?, count?, device?: { id, ip?, name?, network? }, source?: { id?, ip?, name?, port? }, destination?: { id?, ip?, name?, port? }, // Flow-level classification fields (NOT nested under destination): country?, region?, domain?, category? }> }

Audit framing:

  • Start broad with sort_by=download:desc to find top bandwidth users.

  • Narrow with query when you've found a device/region of interest.

  • block=false flows to a category:malware destination = missed block, investigate rules.

  • Use group_by for aggregates; use limit=50 or so for fine-grained review.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryNoFirewalla query string (pass-through). See Firewalla docs for the grammar — supports filters like `device.mac:AA:BB:CC:DD:EE:FF`, `blocked:true`, `region:CN`, `ts:>1700000000`, etc. Omit to match everything.
group_byNoGroup results by one or more fields (comma-separated). Examples: `device`, `device,domain`, `region`. When set, results are aggregated per group.
sort_byNoSort expression. Format: `<field>:<asc|desc>`. Common: `ts:desc` (default, newest first), `ts:asc` (oldest first), `download:desc` (biggest flows first).
limitNoMaximum results per page (1–500, default 200). Smaller values are recommended when auditing — easier to review.
cursorNoPagination cursor echoed from a prior response's `next_cursor`. Omit for the first page.
response_formatNoOutput format. 'markdown' (default) renders human-readable audit tables. 'json' returns structured data suitable for chaining into another tool call.markdown

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, covering safety and idempotency. The description adds valuable behavioral context beyond annotations: it explains the tool's primary use for audit/inspection ('inspect what's actually happening on the wire'), provides strategic guidance in the 'Audit framing' section, and hints at typical workflows (e.g., 'Start broad... Narrow with query'). It doesn't mention rate limits or authentication needs, but adds meaningful operational context.

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

Conciseness4/5

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

The description is well-structured with clear sections: purpose statement, usage examples, parameter details, return format, and audit guidance. Every sentence adds value, though it's somewhat lengthy (which is justified given the tool's complexity). The information is front-loaded with the core purpose and usage examples immediately visible.

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 complex search tool with 6 parameters and no output schema, the description provides exceptional completeness. It includes: clear purpose, specific usage examples, detailed parameter explanations with examples, return format documentation, and strategic audit guidance. The combination of thorough parameter coverage in the schema and rich contextual information in the description makes this fully self-contained for an AI agent.

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 description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds value by providing concrete query examples in the 'Args' section (e.g., 'blocked:true', 'region:CN', 'device.mac:AA:BB:CC:DD:EE:FF') and explaining the purpose of each parameter in context. It also clarifies the relationship between parameters in the 'Audit framing' section (e.g., 'Use group_by for aggregates; use limit=50 or so for fine-grained review').

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 explicitly states the tool's purpose: 'Search network flows observed by Firewalla with the MSP query grammar. Use this to inspect what's actually happening on the wire.' It clearly distinguishes this from sibling tools like firewalla_get_alarm or firewalla_list_devices by focusing on flow inspection rather than alarms, devices, or rules.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool through the 'Use this to answer' section with five concrete examples (e.g., 'Any outbound flows to region:CN that were NOT blocked?', 'Top talkers by download volume over the last 24h?'). The 'Audit framing' section offers strategic advice on starting broad and narrowing down, plus specific use cases like investigating missed blocks.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 8 tool updatesv0.1.0
    • First observedfirewalla_get_alarm
    • First observedfirewalla_get_target_list
    • First observedfirewalla_list_boxes
    • First observedfirewalla_list_devices
    • First observedfirewalla_list_rules
    • First observedfirewalla_list_target_lists
    • First observedfirewalla_search_alarms
    • First observedfirewalla_search_flows

TDQS

A4.6/5.0

Scored across 8 tools

Disambiguation5/5

Each tool has a distinct purpose targeting specific Firewalla resources: list_* tools fetch collections, get_* tools retrieve single items, and search_* tools query with filters. There is no overlap in functionality; for example, firewalla_get_alarm and firewalla_search_alarms serve complementary drill-down and overview roles without ambiguity.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern with the prefix 'firewalla_' and snake_case throughout. Verbs are clear and standardized: 'list' for collections, 'get' for single items, and 'search' for filtered queries. This predictability makes it easy to understand each tool's intent at a glance.

Tool Count5/5

With 8 tools, the server is well-scoped for network security auditing. It covers essential resources (boxes, devices, rules, alarms, flows, target lists) without being overwhelming. Each tool earns its place by addressing a distinct aspect of Firewalla monitoring, fitting the domain's complexity appropriately.

Completeness4/5

The toolset provides comprehensive read-only coverage for auditing Firewalla MSP data, including inventory, rules, alarms, and network flows. Minor gaps exist, such as no tools for modifying rules or managing devices, but these are consistent with an audit-focused server, and agents can work around this by using the provided search and list tools effectively.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Read-only MCP server that allows AI assistants to query and monitor KVM Fleet devices, audit logs, and console sessions through the official REST API.
    5
    9 npm
    1
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    A read-only MCP server that gives Claude safe access to Kubernetes clusters, enabling listing, describing, and monitoring resources without mutation risks and with secret masking.
    1
    MIT