Skip to main content
Glama
mhajder

librenms-mcp

by mhajder
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Oxidized Config Search

oxidized_config_search
Read-onlyIdempotent

Search all stored Oxidized device configurations for a string to find matching configs by IP address, interface, ACL, or keyword.

Instructions

Search all Oxidized device configurations for a string.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return
offsetNoNumber of results to skip (offset) for pagination
searchYesSearch string to look for in all stored device configs (e.g. an IP address, interface name, ACL name, or any config keyword). Must not contain '/': LibreNMS cannot route it, so search for a part without it (e.g. '10.0.0.0' instead of '10.0.0.0/24').

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.12.0
    • changedInput schema / properties / search / description
      Previous value: -"Search string to look for in all stored device configs (e.g. an IP address, interface name, ACL name, or any config keyword)"New value: +"Search string to look for in all stored device configs (e.g. an IP address, interface name, ACL name, or any config keyword). Must not contain '/': LibreNMS cannot route it, so search for a part without it (e.g. '10.0.0.0' instead of '10.0.0.0/24')."
  2. Changed2 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"
+}
  3. First observedv1.9.0

TDQS

B3.3/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds no behavioral context beyond that – no auth requirements, rate limits, or notes about how results are produced – so it contributes little value over the structured fields.

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?

A single, front-loaded sentence with no wasted words that states the core action and target immediately.

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 no explanation, and annotations carry the safety profile. However, for a search tool the description omits pagination behavior context and any differentiation from the sibling oxidized_config_get, leaving it only minimally viable.

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 all three parameters (search, limit, offset) are already documented in the schema, including the important note about '/' not being routable. The description adds no parameter detail, so the baseline 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 gives a specific verb (Search) and resource (all Oxidized device configurations) with the scope of matching against a string. It is clearly a search tool, distinguishable from the read-style siblings oxidized_config_get and oxidized_list, though it never explicitly names them.

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

Usage Guidelines3/5

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

Usage is only implied: 'search all configs for a string' suggests using it when you want to locate content within configs. There is no explicit when-to-use, when-not-to-use, or mention of the alternative oxidized_config_get for retrieving a single device's config.

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