Skip to main content
Glama
amittell

firewalla-mcp-server

by amittell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_target_lists

Read-only

Retrieve target lists by owner (global or box), returning entry counts and target details. Use to inspect firewall list membership.

Instructions

Retrieve target lists (GET /v2/target-lists). Without owner the API returns the MSP's global lists and the Firewalla-managed lists; owner selects global lists, a box's lists, or several. entry_count is the number of entries in each list; the API does not return the entries of Firewalla-managed lists, so their targets is null. Returns up to limit lists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitYesMaximum number of target lists to return (required)
ownerNoOnly lists with this owner: "global" (MSP lists), a box gid (that box's lists), or several comma-separated, e.g. "global,<box_gid>". Default: global and Firewalla-managed lists.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.5.0
    • addedInput schema / properties / owner
      Added value: +{
+  "description": "Only lists with this owner: \"global\" (MSP lists), a box gid (that box's lists), or several comma-separated, e.g. \"global,<box_gid>\". Default: global and Firewalla-managed lists.",
+  "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?

The annotations already declare readOnlyHint and openWorldHint. The description adds valuable context about the response: entry_count is provided, and Firewalla-managed lists have null targets because entries are not returned. It also notes the limit behavior. This complements the annotations without contradicting them.

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 three sentences, front-loaded with the endpoint and core behavior. It avoids unnecessary filler and includes important details about response fields and limits. It is appropriately sized for the tool's complexity.

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 simple list-retrieval tool with no output schema, the description covers the key aspects: owner selection, default scope, entry_count, null targets for Firewalla-managed lists, and the limit parameter. Nothing essential is missing for an agent to call it correctly.

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 both parameters are well-documented in the schema itself. The description adds minimal extra value: it repeats the default owner behavior and mentions the limit behavior. Since the schema already explains owner options and default, the description does not significantly enhance parameter understanding.

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 retrieves target lists, specifies the endpoint, and explains the behavior with and without the owner parameter. It distinguishes the scope (global, box, or multiple owners) and the default behavior, making it unambiguous what this tool does relative to siblings like get_specific_target_list.

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 explains when to use this tool: to fetch target lists with optional owner filtering, and describes default behavior. It does not explicitly mention alternatives or when not to use it, but the context is clear enough for an agent to select it for list retrieval.

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