Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_dns_delete_override

Delete a DNS host override by UUID to remove custom DNS entries. Apply changes with the activate command.

Instructions

Delete a DNS host override by UUID. Run opnsense_dns_apply afterwards to activate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesUUID of the host override to delete

Implementation Reference

  • The handler function that executes the 'opnsense_dns_delete_override' tool. It parses the UUID from args using DeleteOverrideSchema, then sends a DELETE request to the OPNsense API endpoint /unbound/settings/delHostOverride/{uuid}.
    case "opnsense_dns_delete_override": {
      const { uuid } = DeleteOverrideSchema.parse(args);
      const result = await client.post(`/unbound/settings/delHostOverride/${uuid}`);
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • Zod schema for input validation of the delete override tool. Expects a single 'uuid' field validated by UuidSchema (UUID format).
    const DeleteOverrideSchema = z.object({
      uuid: UuidSchema,
    });
  • The UuidSchema helper used by DeleteOverrideSchema to validate UUID format.
    export const UuidSchema = z
      .string()
      .uuid("Invalid UUID format");
  • Tool definition registration in the dnsToolDefinitions array. Declares the tool name, description, and JSON input schema for the MCP ListTools response.
    {
      name: "opnsense_dns_delete_override",
      description:
        "Delete a DNS host override by UUID. Run opnsense_dns_apply afterwards to activate.",
      inputSchema: {
        type: "object" as const,
        properties: {
          uuid: { type: "string", description: "UUID of the host override to delete" },
        },
        required: ["uuid"],
      },
    },
  • src/index.ts:59-59 (registration)
    Registration of the DNS tool handler in the MCP server's tool handler map. Maps each DNS tool definition name to the handleDnsTool function.
    for (const def of dnsToolDefinitions) toolHandlers.set(def.name, handleDnsTool);
Behavior3/5

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

With no annotations provided, the description must disclose behavioral traits. It correctly indicates that deletion requires a separate apply step for activation. However, it does not mention if the deletion is permanent, reversible, or requires specific privileges, leaving some gaps.

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 exceptionally concise: one sentence for purpose, one for the critical follow-up action. No unnecessary words, and the key information is front-loaded.

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 delete operation with a single parameter and no output schema, the description covers the core requirements: what it does, how to identify the resource (UUID), and the required next step. A minor improvement would be to explicitly state that the deletion takes effect only after apply, which is already implied.

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 already fully describes the lone parameter ('uuid') with a clear description. The description adds no additional semantic value beyond stating 'by UUID', so it meets the baseline for 100% schema coverage.

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') and the resource ('DNS host override'), with the specific method ('by UUID'). It distinguishes from sibling tools like opnsense_dns_add_override, opnsense_dns_list_overrides, etc.

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 includes a crucial follow-up step: 'Run opnsense_dns_apply afterwards to activate.' This guides the agent on the required post-action. However, it lacks explicit when-to-use/not-use context compared to alternatives like updating or adding an override.

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