Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_vlan_list

List all configured 802.1Q VLAN interfaces on OPNsense, including parent interface, VLAN tag, description, and priority.

Instructions

List all configured 802.1Q VLAN interfaces (parent interface, VLAN tag, description, priority)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Tool definition/registration for 'opnsense_vlan_list' in the vlanToolDefinitions array
    name: "opnsense_vlan_list",
  • Input schema for opnsense_vlan_list — no parameters required (empty object)
    inputSchema: { type: "object" as const, properties: {} },
  • Handler for opnsense_vlan_list: makes a GET request to /interfaces/vlan_settings/searchItem and returns the JSON result
    case "opnsense_vlan_list": {
      const result = await client.get("/interfaces/vlan_settings/searchItem");
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • src/index.ts:68-68 (registration)
    Maps the 'opnsense_vlan_list' tool name to its handler function handleVlanTool
    for (const def of vlanToolDefinitions) toolHandlers.set(def.name, handleVlanTool);
  • src/index.ts:49-49 (registration)
    Spreads vlanToolDefinitions (including opnsense_vlan_list) into the allToolDefinitions list that gets served to MCP clients
    ...vlanToolDefinitions,
Behavior3/5

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

No annotations are provided, so the description carries the burden of behavioral disclosure. It implies a read-only operation by listing interfaces, but does not explicitly state that it is safe or non-destructive. Adequate but could be improved with a safety mention.

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, front-loaded sentence that efficiently communicates the tool's purpose and output fields. Every word earns its place.

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 parameter-less list tool with no output schema, the description provides sufficient context by specifying the output fields. No additional information is necessary for an agent to understand what the tool returns.

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?

The input schema has no parameters, and schema description coverage is 100%. The description adds no parameter information because none is needed. Baseline for zero parameters is 4, and the description appropriately states the output fields.

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 it lists 802.1Q VLAN interfaces and specifies the exact fields returned (parent interface, VLAN tag, description, priority). This distinguishes it from sibling tools like opnsense_vlan_create, opnsense_vlan_delete, and opnsense_vlan_update.

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 indicates the tool lists all configured VLANs, making its use case clear. It doesn't explicitly state when not to use it or provide alternatives, but the sibling tool names imply this is for viewing only, creating a clear context.

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