clr-librenms-mcp
MCP server for LibreNMS network monitoring — query devices, alerts, sensors, ports, and more through AI assistants like Claude.
Features
- Device monitoring — list devices, health summary, availability, outages, down devices
- Alert management — list, filter, acknowledge alerts, alert rules
- Sensor data — health sensors by device and type (temperature, voltage, fan, etc.)
- Port/interface info — list ports, search by name, find by MAC address
- ARP & FDB lookups — resolve IPs to MACs, find MAC on switch ports
- Hardware inventory — chassis, modules, power supplies, serial numbers
- IP address management — list IPs assigned to devices
- Token-based auth — simple X-Auth-Token authentication
Installation
pip install clr-librenms-mcp
# or
uvx clr-librenms-mcp
Configuration
Preferred: Configuration file at ~/.config/librenms/credentials.json (chmod 600):
{
"url": "https://librenms.example.com",
"token": "your-api-token"
}
Alternative: Environment variables are also supported:
| Variable | Description | Example |
|---|---|---|
LIBRENMS_URL |
LibreNMS base URL | https://librenms.example.com |
LIBRENMS_TOKEN |
API token (generate in LibreNMS UI under API Settings) | abc123... |
Optional:
| Variable | Description | Default |
|---|---|---|
LIBRENMS_READ_ONLY |
Run in read-only mode | false |
LIBRENMS_TRANSPORT |
Transport protocol (stdio or http) |
stdio |
LIBRENMS_LOG_LEVEL |
Log level | INFO |
Claude Desktop
Add to your claude_desktop_config.json:
{
"mcpServers": {
"librenms": {
"command": "uvx",
"args": ["clr-librenms-mcp"]
}
}
}
Claude Code
Add via CLI:
claude mcp add librenms -- uvx clr-librenms-mcp
Or add to your .mcp.json:
{
"librenms": {
"command": "uvx",
"args": ["clr-librenms-mcp"]
}
}
VS Code
Add to your VS Code settings or .vscode/mcp.json:
{
"mcp": {
"servers": {
"librenms": {
"command": "uvx",
"args": ["clr-librenms-mcp"]
}
}
}
}
Note: Configuration is read from ~/.config/librenms/credentials.json or environment variables. No need to specify credentials in MCP config files.
HTTP Transport
To run as a standalone HTTP server:
clr-librenms-mcp --transport http --host 0.0.0.0 --port 8000
Tools
System
| Tool | Description |
|---|---|
librenms_system |
Get LibreNMS version and system information |
Devices
| Tool | Description | Parameters |
|---|---|---|
librenms_list_devices |
List all monitored devices | device_type?, query? |
librenms_get_device |
Get full detail for a single device | device |
librenms_down_devices |
List all devices currently down | — |
librenms_device_summary |
Aggregate status summary (up/down/disabled) | — |
librenms_device_availability |
Availability percentages (24h, 7d, 30d, 365d) | device |
librenms_device_outages |
Outage history for a device | device |
librenms_device_ips |
IP addresses assigned to a device | device |
librenms_inventory |
Hardware inventory (chassis, modules, PSUs) | device, physical_class? |
Alerts
| Tool | Description | Parameters |
|---|---|---|
librenms_list_alerts |
List alerts with optional filters | state?, severity? |
librenms_get_alert |
Get full detail for a single alert | alert_id |
librenms_alert_count |
Alert count by state and severity | — |
librenms_ack_alert |
Acknowledge an alert | alert_id, note? |
librenms_list_alert_rules |
List all alert rules | — |
Alert filter values:
| Parameter | Accepted values |
|---|---|
state |
active, acknowledged, resolved |
severity |
ok, warning, critical |
Sensors & Health
| Tool | Description | Parameters |
|---|---|---|
librenms_list_sensors |
List all sensors or filter by device | device? |
librenms_device_health |
Health sensors for a device by type | device, health_type? |
Health types: temperature, voltage, fanspeed, power, humidity, state, and more.
Ports & Interfaces
| Tool | Description | Parameters |
|---|---|---|
librenms_list_ports |
List ports/interfaces for a device | device |
librenms_search_ports |
Search ports by name, alias, or description | search |
librenms_port_by_mac |
Find port(s) by MAC address | mac |
Network Lookups
| Tool | Description | Parameters |
|---|---|---|
librenms_arp_lookup |
ARP lookup by IP, MAC, or CIDR | query, device? |
librenms_fdb |
MAC/FDB table for a device | device |
Example Usage
Once connected, you can ask your AI assistant things like:
- "Are any devices down in LibreNMS?"
- "Show me all critical alerts"
- "What are the temperature sensors on router01?"
- "Find which switch port has MAC aa:bb:cc:dd:ee:ff"
- "What's the availability for switch01 over the last 30 days?"
- "Acknowledge alert 42"
- "Show me the ARP table for 10.0.0.0/24"
- "List the hardware inventory for core-switch"
Safety
All tools are read-only except librenms_ack_alert, which is a non-destructive write operation — it marks an alert as acknowledged but does not modify device configuration or monitoring state.
Technical Notes
- Auth: Token-based via X-Auth-Token header (generate tokens in LibreNMS under API Settings)
- API version: Uses LibreNMS REST API v0
- Device parameter: Most tools accept hostname, IP address, or device_id interchangeably
- Sensors: Use
librenms_device_healthwithhealth_typefor filtered sensor views, orlibrenms_list_sensorsfor all sensors across all devices
Development
git clone https://github.com/clearminds/clr-librenms-mcp.git
cd clr-librenms-mcp
uv sync
uv run clr-librenms-mcp
License
MIT — see LICENSE for details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file clr_librenms_mcp-1.0.0.tar.gz.
File metadata
- Download URL: clr_librenms_mcp-1.0.0.tar.gz
- Upload date:
- Size: 89.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
79501e3f1729c36dc97bfd997d7e67b0d9fc027ee5d861075333d48bc598bfc8
|
|
| MD5 |
8cdbcdb9d6e9cc10356cddd7a7652c06
|
|
| BLAKE2b-256 |
f880b30c58de8f3820cb3870aaf2549a6384e6f944b1675b88426b777fe30a66
|
Provenance
The following attestation bundles were made for clr_librenms_mcp-1.0.0.tar.gz:
Publisher:
publish.yml on clearminds/clr-librenms-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
clr_librenms_mcp-1.0.0.tar.gz -
Subject digest:
79501e3f1729c36dc97bfd997d7e67b0d9fc027ee5d861075333d48bc598bfc8 - Sigstore transparency entry: 2407076558
- Sigstore integration time:
-
Permalink:
clearminds/clr-librenms-mcp@66ccc15232989f852890620663c884e45762b68d -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/clearminds
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@66ccc15232989f852890620663c884e45762b68d -
Trigger Event:
push
-
Statement type:
File details
Details for the file clr_librenms_mcp-1.0.0-py3-none-any.whl.
File metadata
- Download URL: clr_librenms_mcp-1.0.0-py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
31397d4ad1077f489acf5bc79aa93c16bd013d1cc34f66d7df0e87a17dc8fb92
|
|
| MD5 |
d42e173777c701c79a1d11749e08b014
|
|
| BLAKE2b-256 |
f5d5c068c8812921fb71a144f39b141ed3d7f39152590505b9e0a352c71cc108
|
Provenance
The following attestation bundles were made for clr_librenms_mcp-1.0.0-py3-none-any.whl:
Publisher:
publish.yml on clearminds/clr-librenms-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
clr_librenms_mcp-1.0.0-py3-none-any.whl -
Subject digest:
31397d4ad1077f489acf5bc79aa93c16bd013d1cc34f66d7df0e87a17dc8fb92 - Sigstore transparency entry: 2407076777
- Sigstore integration time:
-
Permalink:
clearminds/clr-librenms-mcp@66ccc15232989f852890620663c884e45762b68d -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/clearminds
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@66ccc15232989f852890620663c884e45762b68d -
Trigger Event:
push
-
Statement type: