Skip to main content
Glama
Observium MCP Server

Observium MCP Server

by kdesch5000

list_ports

List a device's network ports with operational status, speed, and traffic counters, then use the returned port_id to query detailed bandwidth data.

Instructions

List network ports/interfaces for a device.

Returns all network interfaces with their operational state, speed, and basic traffic counters. Essential for finding port_ids before querying traffic details.

RETURNS: Array of ports with:

  • port_id: Unique identifier (use with get_port_traffic)

  • name: Interface name (e.g., 'GigabitEthernet0/1', 'eth0')

  • description: Interface description from device

  • alias: Configured port description/label

  • speed: Port speed (e.g., '1 Gbps', '10 Gbps')

  • admin_status: Administrative state (up/down)

  • oper_status: Operational state (up/down)

  • in_octets, out_octets: Total bytes transferred

  • in_errors, out_errors: Error counters

EXAMPLE QUESTIONS:

  • "What ports are on the switch?"

  • "Show me all active interfaces on the router"

  • "Which ports have errors?"

  • "List ports that are admin up but operationally down"

NEXT STEPS: Use port_id with get_port_traffic for detailed bandwidth analysis

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_ports"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostnameNoThe hostname or IP address
device_idNoThe device ID (get from list_devices)
oper_statusNoFilter by operational status
admin_statusNoFilter by administrative status

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.1/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden; it discloses this is a non-destructive read and documents the full return shape (state, speed, counters, errors), which is behavior an agent can rely on. It omits pagination, result limits, and what happens when a device is unreachable or filters match nothing.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded and the RETURNS/EXAMPLE/NEXT STEPS blocks are clearly delineated and scannable. The example-question block is somewhat padded and the returns enumeration is long, but with no output schema it earns most of its space.

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?

With no annotations and no output schema, the description correctly compensates by enumerating return fields and pointing to the follow-up tool. The remaining gap is parameter disambiguation between hostname and device_id for a tool where neither is required.

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 enums are self-explanatory, so the baseline is 3. The description adds no guidance on the key ambiguity the schema leaves open: whether to supply hostname or device_id, or which one takes precedence.

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 opening line states a specific verb and resource ('List network ports/interfaces for a device') and the NEXT STEPS line explicitly routes traffic queries to get_port_traffic, so an agent can separate this tool from its closest sibling without opening either schema.

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?

It gives a clear triggering condition ('Essential for finding port_ids before querying traffic details') and hands off to get_port_traffic for bandwidth work, reinforced by four realistic example questions. It stops short of explicit exclusions or stating prerequisites such as needing a device_id from list_devices.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.