Skip to main content
Glama
amittell

firewalla-mcp-server

get_boxes

Read-only

List Firewalla boxes visible to an MSP token, optionally within one group, with online status, model, and version. Use for inventory and monitoring across managed boxes.

Instructions

List the Firewalla boxes this MSP token can see (GET /v2/boxes, optionally one box group), with online status, model and version. Not limited by FIREWALLA_BOX_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
groupNoGet boxes within a specific group (requires group ID)
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. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the HTTP endpoint, the token-level scope, and the fields returned, but says nothing about pagination, result caps, or rate limits against a live MSP API.

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?

A single front-loaded sentence containing the verb, the scope, the endpoint, the optional filter, the returned fields, and the env-var carve-out. No filler, no repetition of the title.

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 usefully names the payload fields (online status, model, version) and both parameters are fully documented in the schema. It is nearly complete, though pagination behavior and any error/empty-result semantics remain unstated.

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 group parameter's own description already states it needs a group ID, so the schema does the heavy lifting. The description's "optionally one box group" merely restates the group parameter rather than adding format, ID syntax, or interaction detail beyond it.

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 ("List the Firewalla boxes"), names the backing endpoint (GET /v2/boxes), scopes it to the MSP token, and enumerates the returned fields (online status, model, version). No sibling tool in the list also enumerates boxes, so the agent can identify it immediately.

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?

Clarifies the scoping rule that matters most here: "Not limited by FIREWALLA_BOX_ID" tells the agent this call spans all boxes the token sees, and "optionally one box group" describes the narrowing case. It offers no explicit when-not-to-use or named alternative, so it stops short of a 5.

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