Skip to main content
Glama
itunified-io

mcp-opnsense

by itunified-io

opnsense_diag_system_info

Retrieve OPNsense firewall diagnostics: CPU, memory, uptime, disk, and software version status.

Instructions

Get system status information (CPU, memory, uptime, disk, versions)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Tool definition registration for 'opnsense_diag_system_info' with description and empty input schema.
    {
      name: "opnsense_diag_system_info",
      description: "Get system status information (CPU, memory, uptime, disk, versions)",
      inputSchema: { type: "object" as const, properties: {} },
    },
  • Handler implementation for 'opnsense_diag_system_info': calls client.get('/core/system/status') and returns JSON result.
    case "opnsense_diag_system_info": {
      const result = await client.get("/core/system/status");
      return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
    }
  • src/index.ts:28-28 (registration)
    Import of diagnosticsToolDefinitions and handleDiagnosticsTool from diagnostics.ts
    import { diagnosticsToolDefinitions, handleDiagnosticsTool } from './tools/diagnostics.js';
  • src/index.ts:42-42 (registration)
    Spread of diagnosticsToolDefinitions into the aggregated allToolDefinitions array.
    ...diagnosticsToolDefinitions,
  • src/index.ts:61-61 (registration)
    Registration of all diagnostics tool definitions (including opnsense_diag_system_info) to the shared handleDiagnosticsTool handler.
    for (const def of diagnosticsToolDefinitions) toolHandlers.set(def.name, handleDiagnosticsTool);
Behavior4/5

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

With no annotations, the description carries the full burden. It honestly lists the information categories returned, which is sufficient for a diagnostic read-only tool. However, it does not mention authentication needs or error conditions.

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?

Single concise sentence with specific details in parentheses. No wasted words; front-loaded with the action and resource.

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 diagnostic tool with no parameters and no output schema, the description provides sufficient context. It could mention output format or safety, but the current version is adequate for an agent to decide when to use it.

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 is empty, and schema coverage is 100%. With zero parameters, the baseline is 4, and the description adds no additional parameter information, which is acceptable.

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 verb 'Get' and the resource 'system status information' with specific examples (CPU, memory, uptime, disk, versions). This distinguishes it from sibling diagnostic tools like ping, traceroute, or firewall logs.

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 implies usage for general system health checks, but does not explicitly contrast with the similar sibling 'opnsense_sys_info', which may cause slight ambiguity. It provides clear context but lacks exclusionary guidance.

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