Skip to main content
Glama
mhajder

librenms-mcp

by mhajder
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Ports List

ports_list
Read-onlyIdempotent

Retrieve all ports from LibreNMS with optional filters, including device, columns, limit, and offset, to query network interfaces and their status.

Instructions

Get all ports from LibreNMS with optional filters.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return
queryNoQuery parameters for filtering ports: - columns: Comma-separated list of fields to return (e.g., "port_id,ifName,ifAlias") - device_id: Only return ports of this device (device ID or hostname) Available columns: port_id, device_id, ifDescr, ifName, ifAlias, ifType, ifSpeed, ifOperStatus, ifAdminStatus, etc.
offsetNoNumber of results to skip (offset) for pagination

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.12.0
    • changedInput schema / properties / query / description
      Previous value: -"Query parameters for filtering ports:\n- columns: Comma-separated list of fields to return (e.g., \"port_id,ifName,ifAlias\")\n- device_id: Filter by device ID\n\nAvailable columns: port_id, device_id, ifDescr, ifName, ifAlias, ifType, ifSpeed, ifOperStatus, ifAdminStatus, etc."New value: +"Query parameters for filtering ports:\n- columns: Comma-separated list of fields to return (e.g., \"port_id,ifName,ifAlias\")\n- device_id: Only return ports of this device (device ID or hostname)\n\nAvailable columns: port_id, device_id, ifDescr, ifName, ifAlias, ifType, ifSpeed, ifOperStatus, ifAdminStatus, etc."
  2. Changed3 schema fields changedv1.10.3
    • addedInput schema / properties / limit
      Added value: +{
+  "default": 100,
+  "description": "Maximum number of results to return",
+  "minimum": 1,
+  "type": "integer"
+}
    • addedInput schema / properties / offset
      Added value: +{
+  "default": 0,
+  "description": "Number of results to skip (offset) for pagination",
+  "minimum": 0,
+  "type": "integer"
+}
    • changedInput schema / properties / query / description
      Previous value: -"Query parameters for filtering ports:\n- columns: Comma-separated list of fields to return (e.g., \"port_id,ifName,ifAlias\")\n- device_id: Filter by device ID\n- limit: Maximum number of results\n\nAvailable columns: port_id, device_id, ifDescr, ifName, ifAlias, ifType, ifSpeed, ifOperStatus, ifAdminStatus, etc."New value: +"Query parameters for filtering ports:\n- columns: Comma-separated list of fields to return (e.g., \"port_id,ifName,ifAlias\")\n- device_id: Filter by device ID\n\nAvailable columns: port_id, device_id, ifDescr, ifName, ifAlias, ifType, ifSpeed, ifOperStatus, ifAdminStatus, etc."
  3. First observedv1.9.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds nothing beyond that profile — no note on pagination behavior, result volume, or default scoping — so it contributes no behavioral context of its own.

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?

A single compact sentence with no filler and the core action front-loaded. It is efficient, though its brevity is partly under-specification rather than disciplined trimming.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and annotations cover safety. Still, for a list tool sitting among many port-listing siblings, the description omits the scoping and selection guidance an agent needs to pick it correctly, making it only minimally adequate.

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 description coverage is 100%, so limit, offset, and the query object are fully documented in the schema itself, including the available columns and device_id filter. The description adds no parameter meaning beyond that, which is the expected baseline when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (get) and resource (ports) plus the source system (LibreNMS), so the operation is unambiguous. However, it does nothing to distinguish itself from several siblings that also enumerate ports (device_ports, device_ports_get, ports_search), leaving an agent to guess which list endpoint applies.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'with optional filters' hints that filtering is possible but never says when to choose this tool over ports_search, device_ports, or port_get. No prerequisites, scope constraints, or exclusion conditions are given.

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

Deploy Server

Other Tools