Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_firmware_remove

Remove an installed OPNsense plugin package. Requires explicit confirmation to prevent accidental removal.

Instructions

Remove an installed OPNsense plugin package. DESTRUCTIVE: requires explicit confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
packageYesPlugin package name to remove
confirmYesMust be true to confirm the removal

Implementation Reference

  • Handler case for opnsense_firmware_remove: parses args with RemovePackageSchema and calls POST /core/firmware/remove/{package}
    case "opnsense_firmware_remove": {
      const parsed = RemovePackageSchema.parse(args);
      const result = await client.post("/core/firmware/remove/" + encodeURIComponent(parsed.package));
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • Zod schema RemovePackageSchema validating that package (string) and confirm (literal true) are provided
    const RemovePackageSchema = z.object({
      package: z.string().min(1, "Package name is required"),
      confirm: ConfirmTrue("confirm must be true to proceed with package removal"),
    });
  • Tool definition registration: declares opnsense_firmware_remove with description, input schema (package + confirm boolean)
    {
      name: "opnsense_firmware_remove",
      description:
        "Remove an installed OPNsense plugin package. DESTRUCTIVE: requires explicit confirmation.",
      inputSchema: {
        type: "object" as const,
        properties: {
          package: {
            type: "string",
            description: "Plugin package name to remove",
          },
          confirm: {
            type: "boolean",
            description: "Must be true to confirm the removal",
            enum: [true],
          },
        },
        required: ["package", "confirm"],
      },
    },
  • src/index.ts:66-66 (registration)
    All firmware tool definitions (including opnsense_firmware_remove) are mapped to handleFirmwareTool handler in the main tool handler map
    for (const def of firmwareToolDefinitions) toolHandlers.set(def.name, handleFirmwareTool);
  • ConfirmTrue helper: pre-processes boolean strings to coerce 'true' string to true boolean before literal validation
    const ConfirmTrue = (msg: string) =>
      z.preprocess(
        (v) => (v === "true" ? true : v === "false" ? false : v),
        z.literal(true, { errorMap: () => ({ message: msg }) }),
      );
Behavior4/5

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

With no annotations, the description carries the full burden for behavioral disclosure. It explicitly labels the tool as DESTRUCTIVE and notes the confirmation requirement, which is sufficient for a simple removal operation.

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?

Single sentence followed by a clear warning. Every word serves a purpose, with the destructive nature front-loaded. No wasted text.

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 simple removal tool with two parameters and no output schema, the description covers the essential behavioral traits: what it does, destructiveness, and confirmation. Could optionally mention result format, but not necessary.

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%, so the schema already describes both parameters. The description reinforces the 'confirm' requirement but does not add additional semantic context beyond what the schema provides. Baseline 3 is appropriate.

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?

Description clearly states the action (remove), the resource (installed OPNsense plugin package), and includes a prominent destructive warning. This distinguishes it from sibling tools like install or upgrade.

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?

Warns that the action is destructive and requires explicit confirmation, guiding the agent to use this tool only when removal is intended. Does not explicitly list when not to use or alternatives, but the context is clear.

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