Skip to main content
Glama
mhajder

librenms-mcp

by mhajder
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Ports List

ports_list
Read-onlyIdempotent

Query network ports from LibreNMS with optional filters like device ID and columns; paginate with limit and offset.

Instructions

Get all ports from LibreNMS with optional filters.

Input Schema

TableJSON 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: Filter by device ID Available columns: port_id, device_id, ifDescr, ifName, ifAlias, ifType, ifSpeed, ifOperStatus, ifAdminStatus, etc.
offsetNoNumber of results to skip (offset) for pagination

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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."
  2. First observedv1.9.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, covering the safety profile. The description adds the scope ('all ports from LibreNMS') and optional filtering, but does not disclose pagination behavior, defaults, or result-set characteristics beyond what the schema and output schema provide.

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 compact sentence with no filler. The key action and scope are front-loaded, making it immediately parseable and appropriate in length.

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?

For a simple read-only listing tool, the schema, annotations, and output schema cover most operational details. However, the sibling list contains multiple port-related tools, and the description does not clarify when this global list is the right choice, leaving an agent to infer the boundaries.

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%, with limit, query, and offset each documented. The description's 'optional filters' is generic and adds no meaning beyond the schema, so the baseline of 3 applies.

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?

The description uses a specific verb and resource: 'Get all ports from LibreNMS with optional filters.' It clearly indicates a global listing operation rather than a device-scoped one, though it does not explicitly contrast with sibling tools like ports_search or device_ports_get.

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?

No guidance is given about when to use ports_list versus the many related siblings such as device_ports_get, ports_search, or port_get. The phrase 'all ports' hints at broad use, but there are no exclusions, alternatives, or selection criteria.

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