Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_firmware_list_plugins

Retrieve a list of all OPNsense plugins, showing which are available and installed, along with their versions and current status.

Instructions

List all available and installed OPNsense plugins with their versions and status

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for opnsense_firmware_list_plugins: calls GET /core/firmware/info via the OPNsenseClient and extracts the plugin/package list from the response.
    case "opnsense_firmware_list_plugins": {
      const result = await client.get("/core/firmware/info");
      const info = result as Record<string, unknown>;
      const plugins = (info.package ?? info.plugin ?? []) as unknown[];
      return { content: [{ type: "text", text: JSON.stringify(plugins, null, 2) }] };
    }
  • Tool definition registration for opnsense_firmware_list_plugins in the firmwareToolDefinitions array, defining its name, description, and empty inputSchema.
    {
      name: "opnsense_firmware_list_plugins",
      description:
        "List all available and installed OPNsense plugins with their versions and status",
      inputSchema: { type: "object" as const, properties: {} },
    },
  • The OPNsenseClient.get method used by the handler to perform the HTTP GET request to /core/firmware/info.
    async get<T>(path: string): Promise<T> {
      try {
        const response = await this.http.get<T>(path);
        return response.data;
      } catch (error: unknown) {
        throw extractError(error, `GET ${path}`);
      }
    }
Behavior4/5

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

The description implies a read-only operation (list), and no annotations are provided. It does not mention side effects, authentication, or rate limits, but for a list tool minimal disclosure is acceptable.

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 that efficiently communicates the tool's function with no wasted words.

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?

The description covers the basic purpose and output content (versions and status), but without an output schema, more detail on the return structure could be helpful. However, it is adequate for a simple listing.

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?

No parameters exist, and the input schema is empty with 100% coverage. The description adds no parameter info, but none is needed.

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 lists all available and installed plugins with versions and status, using a specific verb and resource. It distinguishes from sibling firmware tools like check, info, install, etc.

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 vs alternatives like opnsense_firmware_info or opnsense_firmware_check. The purpose is clear but lacks context for selection.

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