Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_acme_delete_account

Delete an ACME account by UUID and apply the changes to synchronize configuration.

Instructions

Delete an ACME account by UUID. Run opnsense_acme_apply afterwards.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesUUID of the account to delete

Implementation Reference

  • The handler function that executes the 'opnsense_acme_delete_account' tool logic. It parses the UUID using DeleteAccountSchema, then sends a POST request to '/acmeclient/accounts/del/{uuid}' to delete the ACME account.
    case "opnsense_acme_delete_account": {
      const { uuid } = DeleteAccountSchema.parse(args);
      const result = await client.post(`/acmeclient/accounts/del/${uuid}`);
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • The DeleteAccountSchema input validation schema. It validates that the input contains a 'uuid' field conforming to UuidSchema (a string with UUID format).
    const DeleteAccountSchema = z.object({
      uuid: UuidSchema,
    });
  • The tool registration definition within acmeToolDefinitions array. It declares the tool name ('opnsense_acme_delete_account'), description, and inputSchema with a required 'uuid' string property.
    {
      name: "opnsense_acme_delete_account",
      description: "Delete an ACME account by UUID. Run opnsense_acme_apply afterwards.",
      inputSchema: {
        type: "object" as const,
        properties: {
          uuid: { type: "string", description: "UUID of the account to delete" },
        },
        required: ["uuid"],
      },
    },
  • The UuidSchema helper used by DeleteAccountSchema. It validates that a string is a properly formatted UUID.
    export const UuidSchema = z
      .string()
      .uuid("Invalid UUID format");
  • src/index.ts:65-65 (registration)
    The tool handler registration in the central index. It iterates over acmeToolDefinitions and maps each tool name (including 'opnsense_acme_delete_account') to the handleAcmeTool function.
    for (const def of acmeToolDefinitions) toolHandlers.set(def.name, handleAcmeTool);
Behavior4/5

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

Given no annotations, the description carries the burden. It discloses the destructive nature (Delete) and implies the need for a follow-up apply. It could mention the irreversible nature, but the action is clear.

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?

Two sentences, no fluff, front-loaded with the main action. Highly concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter tool with clear annotations (none needed), the description is complete: what it does and the required follow-up step.

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%, and the description only reiterates that deletion is by UUID, adding no extra meaning. 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?

The description clearly states the action (Delete) and the resource (ACME account) with the method (by UUID), distinguishing it from sibling tools like add, list, or apply.

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 advises to run 'opnsense_acme_apply afterwards', providing a necessary post-action step. While it doesn't explicitly state when to use or not use this tool, the delete 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