Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_firmware_upgrade_status

Retrieve the progress and log of a running or last completed firmware upgrade on OPNsense.

Instructions

Get the progress/log of a currently running or last completed firmware upgrade (long-running operation status).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for 'opnsense_firmware_upgrade_status': calls GET /core/firmware/upgradestatus on the OPNsense API and returns the result as formatted JSON.
    case "opnsense_firmware_upgrade_status": {
      const result = await client.get("/core/firmware/upgradestatus");
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • Tool definition (registration) for 'opnsense_firmware_upgrade_status': defines name, description, and empty input schema (no parameters).
      name: "opnsense_firmware_upgrade_status",
      description:
        "Get the progress/log of a currently running or last completed firmware upgrade (long-running operation status).",
      inputSchema: { type: "object" as const, properties: {} },
    },
  • src/index.ts:66-66 (registration)
    Registration step that maps each firmware tool definition name (including 'opnsense_firmware_upgrade_status') to the handleFirmwareTool handler function.
    for (const def of firmwareToolDefinitions) toolHandlers.set(def.name, handleFirmwareTool);
Behavior3/5

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

With no annotations provided, the description carries full responsibility for behavioral disclosure. It reveals that the tool returns data from a currently running or last completed upgrade, and labels it as a 'long-running operation status' tool. However, it does not specify whether the call is blocking, if it requires authentication, or what happens if no upgrade has ever occurred. Some behavioral aspects remain implicit.

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 a single sentence that is concise, front-loaded with the action ('Get'), and contains no unnecessary words. Every part of the sentence adds value: verb, object, scope ('currently running or last completed'), and nature ('long-running operation status').

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 tool with no parameters and no output schema, the description provides essential information about purpose and output (progress/log). It is nearly complete but could slightly benefit from mentioning that a firmware upgrade must have been initiated (e.g., via opnsense_firmware_upgrade) for there to be status to retrieve. Nonetheless, it is adequate for the tool's simplicity.

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?

The input schema has zero parameters and schema description coverage is 100%, so the description does not need to add parameter details. The baseline of 3 is appropriate because the description provides no additional semantic value beyond the schema, which is already complete given the absence of parameters.

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 'Get' and the resource 'progress/log of a currently running or last completed firmware upgrade'. It distinguishes itself from siblings like opnsense_firmware_upgrade (which triggers the upgrade) and opnsense_firmware_status (which may provide general firmware status) by specifying the exact function of retrieving upgrade progress/log.

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

Usage Guidelines3/5

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

The description implies usage after triggering a firmware upgrade (via opnsense_firmware_upgrade) by mentioning 'currently running or last completed' and 'long-running operation status', but it does not explicitly state when to use this tool versus alternatives like opnsense_firmware_status, nor does it provide conditions for use or exclusions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/itunified-io/mcp-opnsense'

If you have feedback or need assistance with the MCP directory API, please join our Discord server