Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_firmware_info

Retrieves OPNsense firmware version, architecture, and update status to assess system update needs.

Instructions

Get firmware version, architecture, and update status of the OPNsense system

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler for 'opnsense_firmware_info' — makes a GET request to '/core/firmware/info' and returns the result as formatted JSON.
    case "opnsense_firmware_info": {
      const result = await client.get("/core/firmware/info");
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • Tool definition registration with name 'opnsense_firmware_info', description, and empty input schema (no parameters).
    export const firmwareToolDefinitions = [
      {
        name: "opnsense_firmware_info",
        description:
          "Get firmware version, architecture, and update status of the OPNsense system",
        inputSchema: { type: "object" as const, properties: {} },
      },
  • src/index.ts:33-33 (registration)
    Import of firmwareToolDefinitions and handleFirmwareTool from the firmware module.
    import { firmwareToolDefinitions, handleFirmwareTool } from './tools/firmware.js';
  • src/index.ts:66-66 (registration)
    Registration of handleFirmwareTool as the handler for all firmware tool definitions including 'opnsense_firmware_info'.
    for (const def of firmwareToolDefinitions) toolHandlers.set(def.name, handleFirmwareTool);
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It only states what the tool retrieves (version, architecture, update status) but does not mention that it is read-only, whether it requires any authentication, or if it has any side effects. This is insufficient for a system info tool.

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 of 8 words, front-loading the action and resource. It is concise and contains no unnecessary information, making it efficient for an agent to parse.

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 zero-parameter tool with no output schema, the description adequately covers the key pieces of information returned: firmware version, architecture, and update status. It is complete enough for an agent to understand the tool's output, though additional detail on potential return formats could elevate it to a 5.

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?

The tool has zero parameters, and the schema description coverage is 100%. According to guidelines, a baseline of 4 is appropriate when there are no parameters, as the description does not need to add parameter details beyond the schema.

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 specifies the resource as firmware version, architecture, and update status of the OPNsense system. This distinguishes it from sibling tools like opnsense_firmware_status (likely just status) and opnsense_firmware_check (check for updates).

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?

No explicit guidance on when to use this tool versus other firmware tools such as opnsense_firmware_check or opnsense_firmware_upgrade_status. The description implies it is for reading current info, but it does not state when not to use it or provide alternative options.

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