Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_route_gateway_status

Get live gateway monitor status including online/offline state, RTT, packet loss, stddev, monitor IP, and monitor disabled flag. Read-only for routing diagnostics.

Instructions

Get live gateway monitor status: per-gateway online/offline state, RTT (delay), packet loss, stddev, monitor IP, and monitor_disable flag. Read-only — complements opnsense_route_gateway_list (which only returns config).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for the opnsense_route_gateway_status tool. Executes a GET request to /routes/gateway/status on the OPNsense API and returns the live gateway monitor status as formatted JSON.
    case "opnsense_route_gateway_status": {
      const result = await client.get("/routes/gateway/status");
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • Tool definition (schema) for opnsense_route_gateway_status. Declares the tool name, description, and an empty input schema (no parameters required).
      name: "opnsense_route_gateway_status",
      description: "Get live gateway monitor status: per-gateway online/offline state, RTT (delay), packet loss, stddev, monitor IP, and monitor_disable flag. Read-only — complements opnsense_route_gateway_list (which only returns config).",
      inputSchema: { type: "object" as const, properties: {} },
    },
  • src/index.ts:67-67 (registration)
    Registration: maps every routing tool definition (including opnsense_route_gateway_status) to the handleRoutingTool handler function in the global toolHandlers map.
    for (const def of routingToolDefinitions) toolHandlers.set(def.name, handleRoutingTool);
Behavior4/5

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

With no annotations provided, the description fully carries the burden of behavioral disclosure. It correctly identifies the operation as read-only and lists the returned metrics (online/offline, RTT, packet loss, etc.). It does not mention potential side effects or access requirements, but for a simple query tool the transparency is strong.

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 two sentences long, each serving a distinct purpose: first explaining what the tool returns, second placing it in context with a sibling. No extraneous words; information is front-loaded and efficient.

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?

Given the tool has no parameters, no output schema, and no annotations, the description covers everything needed: purpose, output fields, and relationship to a sibling. It is complete enough for an agent to select and invoke the tool correctly without ambiguity.

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 zero properties, so there are no parameters to explain. The description adds no parameter information because none exists. According to guidelines, with 0 parameters the baseline is 4, and the description meets that by not adding any unnecessary noise.

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 verb 'Get', the resource 'live gateway monitor status', and lists specific fields returned. It explicitly distinguishes from sibling tool opnsense_route_gateway_list by noting it complements the config-only list, making the purpose unambiguous.

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 says 'complements opnsense_route_gateway_list (which only returns config)', providing clear context for when to use this tool versus the sibling. It also marks the tool as read-only, but does not give explicit when-not-to-use scenarios or mention prerequisites, though the context is sufficient.

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