Skip to main content
Glama

delete_virtual_ip

Destructive

Permanently delete a pfSense virtual IP by ID; use dry run and confirmation to prevent accidental irreversible removal.

Instructions

Delete a virtual IP by ID. WARNING: This is irreversible.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "vip_id": "<vip_id>"
    },
    "name": "delete_virtual_ip"
  }
}

Input Schema

NameRequiredDescriptionDefault
vip_idYesVirtual IP ID (from search_virtual_ips)
confirmNoMust be set to True to execute. Safety gate for destructive operations.
dry_runNoIf True, preview the operation without executing.
apply_immediatelyNoWhether to apply changes immediately

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds an 'irreversible' warning, which is useful but does not disclose potential side effects like impact on firewall rules or the need for applying changes.

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 plus a warning, front-loaded with the action and resource. It is concise and free of unnecessary content.

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?

Given the rich schema and annotations, the description is nearly complete. It could mention confirmation requirements or checking for references, but those are available in the schema. The irreversible warning adds needed context.

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 100% coverage with detailed descriptions for all parameters. The description itself adds no additional parameter semantics, but this is acceptable since the schema handles 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?

The description clearly states the action (Delete), the resource (virtual IP), and the identifying method (by ID). It naturally distinguishes itself from sibling tools like create_virtual_ip and update_virtual_ip.

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?

The description provides clear context that this tool is for deleting a virtual IP. It does not explicitly state when to use it over alternatives or mention exclusions, but the purpose is unambiguous.

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

Deploy Server

Other Tools