Serveur MCP librenmsctrl
Commit 29 oct. 2026Permet à un client IA d'inspecter les appareils, les ports, les alertes et les journaux d'événements LibreNMS avec des capacités d'écriture sécurisées pour une surveillance réseau fiable.
Aussi connu sous lidless-labs/librenmsctrl
- Étoiles
- 1
- Outils
- 13
- Téléchargements, 30 jours
- —
- Dernière version
- —
- Dernier commit
- 29 oct. 2026
- Licence
- MIT
Qu'est-ce que librenmsctrl MCP ?
Permet à un client IA d'inspecter les appareils, les ports, les alertes et les journaux d'événements LibreNMS avec des capacités d'écriture sécurisées pour une surveillance réseau fiable. Il expose 13 outils, comme librenms_status, librenms_list_devices, librenms_get_device.
Résumé généré à partir du README du projet
À propos du MCP server librenmsctrl
librenmsctrl fournit une interface structurée pour interagir avec LibreNMS, un système de surveillance réseau open-source. Il fonctionne à la fois comme un outil en ligne de commande local pour les shells et les pipelines CI et comme un adaptateur MCP pour les workflows d'agents IA. Les utilisateurs peuvent inspecter l'infrastructure réseau en interrogeant les appareils, les ports, l'état des ports, les alertes et les journaux d'événements en utilisant un jeton API pour l'authentification.
Ce serveur privilégie la sécurité grâce à un système de contrôle d'écriture par paliers. Alors que les opérations de lecture sont libres, toute modification telle que l'accusé de réception d'une alerte ou la définition d'une fenêtre de maintenance nécessite un indicateur de confirmation explicite. Cela empêche les modifications accidentelles causées par des hallucinations de modèle. Chaque entrée est validée par rapport à un schéma avant d'être envoyée à l'API REST de LibreNMS, et le système masque automatiquement les jetons API de tous les résultats pour protéger les identifiants. La configuration nécessite de fournir l'URL LibreNMS et un jeton API via des variables d'environnement.
Ce que vous pouvez faire avec
- 1Surveiller l'état des équipements réseauUn agent IA peut vérifier le statut et l'utilisation de ports réseau spécifiques pour identifier des erreurs.
- 2Gérer les alertes réseau activesUn développeur peut demander à une IA d'accuser réception ou de lever le mode muet d'alertes spécifiques au sein du système de surveillance.
- 3Auditer les listes d'appareils et de portsVous pouvez utiliser l'outil pour récupérer une liste complète de tous les appareils interrogés via SNMP.
Extrait du README du projet. Chaque cas d'utilisation est vérifié par rapport à une citation du document.
Outils MCP librenmsctrl 13
Détectés depuis le READMElibrenms_statuslibrenms_list_deviceslibrenms_get_devicelibrenms_list_portslibrenms_get_portlibrenms_port_healthlibrenms_list_alertslibrenms_get_alertlibrenms_alert_historylibrenms_event_loglibrenms_ack_alertlibrenms_unmute_alert
| librenms_status | — | |
| librenms_list_devices | — | |
| librenms_get_device | — | |
| librenms_list_ports | — | |
| librenms_get_port | — | |
| librenms_port_health | — | |
| librenms_list_alerts | — | |
| librenms_get_alert | — | |
| librenms_alert_history | — | |
| librenms_event_log | — | |
| librenms_ack_alert | — | |
| librenms_unmute_alert | — |
Afficher les 13 outilsAfficher moins d'outils
librenms_set_maintenance
| librenms_set_maintenance | — |
Configuration
LIBRENMS_TLS_INSECURELIBRENMS_TOKENLIBRENMS_URL
| Nom | Description | Type |
|---|---|---|
| LIBRENMS_TLS_INSECURE | — | |
| LIBRENMS_TOKEN | — | |
| LIBRENMS_URL | — |
Vérifications automatisées
Exécuté le 14 nov. 2026Rapport complet →Pas encore vérifié. Un serveur nécessite un score de 80, aucune faille sérieuse et suffisamment de données pour que nous puissions effectuer les vérifications. Fonctionnement des vérifications · Ce qu'il faut corriger pour gagner des points
- Dépôt source lié et accessiblelidless-labs/librenmsctrl is public and reachablegithub.com/lidless-labs/librenmsctrl ↗Réussi
- Le nom du package correspond au dépôt sourceNon vérifié
- Provenance du build (attestation Sigstore)Non vérifié
- Licence open source (OSI)MITspdx.org/licenses/MIT.html ↗Réussi
- Commit ou version publiée au cours de l'année écouléeLast commit or release 2026-10-29github.com/lidless-labs/librenmsctrl ↗Réussi
- OpenSSF ScorecardNon vérifié
- Nom du package non proche d'un package populaireNon vérifié
- Aucun avis critique dans le package ou ses dépendancesNon vérifié
- Aucune instruction cachée destinée au modèle13 tool descriptions and the README read; no override phrases, credential paths or hidden charactersRéussi
- Les outils destructifs sont étiquetésNo tool named like delete, drop or execRéussi
- Le point de terminaison distant répond à la poignée de main MCPNon vérifié
README
Voir sur GitHublibrenmsctrl is a local operator control CLI for LibreNMS, the open-source network monitoring system. It gives shells, cron, and CI a typed command surface for reading your monitored network: devices, ports, port health, alerts, alert history, and the event log over LibreNMS API-token auth.
The same package remains MCP-compatible for agent workflows. librenmsctrl mcp starts the stdio Model Context Protocol adapter, and the existing librenms-mcp binary continues to work for launchers and configs that already use it. The MCP adapter can acknowledge or mute alerts only when you pass an explicit confirm: true. It differs from pointing an agent at the raw LibreNMS REST API in one way that matters: every write is gated, every argument is schema-validated before it leaves the host, and your token is redacted from all output, so a hallucinated tool call cannot change your monitoring state by accident.
Status: work in progress. v1 ships read tools (tier 1) and confirm-gated safe writes (tier 2) only. Destructive operations (tier 3) such as device deletion, alert-rule removal, and bulk port resets are intentionally deferred until the write-gate pattern has more field time. The read path and the two write gates are tested.
What it does
librenmsctrl turns a LibreNMS instance into a scriptable control surface for network monitoring and observability work: list the devices LibreNMS is polling over SNMP, pull a single device or port, check port health and utilization, read current alerts and alert history, and tail the event log. It authenticates with a LibreNMS API token, talks to the LibreNMS /api/v0 REST API under the hood, and can emit human-readable tables or raw JSON for piping.
For MCP clients, the mcp subcommand exposes the same LibreNMS client core as structured tool output an agent can reason over. The package name is still @solomonneas/librenms-mcp, and the back-compat librenms-mcp bin is intentionally kept stable.
Writes are gated in three tiers:
- Tier 1 (reads): open. No confirm flag. Status, device and port listings, single device or port, port health, alert listings, alert history, event log.
- Tier 2 (safe writes): require an explicit
confirm: trueargument, documented on every write tool's JSON schema. Acknowledge an alert, unmute an alert, or put a device into a maintenance window. A tool call missing the flag throwsWriteGateErrorbefore any HTTP traffic leaves the host. - Tier 3 (destructive): not implemented in v1. When added, ops like device deletion and alert-rule removal will also require
destructive: true. The model cannot bypass either gate from a hallucinated call.
Every tool call is validated against its published TypeBox inputSchema before the tool runs. Ids, port ids, device ids, limits, and the type/state filters are bounds- and enum-checked, so a malformed or injection-style argument is rejected up front and never reaches a LibreNMS URL path or query string. Interpolated path and query values are URL-encoded as defense-in-depth. The API token is registered with the redactor on startup and masked from all log and error output.
Quickstart
Published to npm as @solomonneas/librenms-mcp. Install the package to get the librenmsctrl operator CLI and the back-compat librenms-mcp MCP launcher.
# start the MCP adapter on demand through the back-compat `librenms-mcp` bin
npx -y @solomonneas/librenms-mcp
# install the global `librenmsctrl` and `librenms-mcp` binaries
npm install -g @solomonneas/librenms-mcp
It needs Node 20+ and two env vars, LIBRENMS_URL and LIBRENMS_TOKEN.
export LIBRENMS_URL=https://librenms.example.local
export LIBRENMS_TOKEN=<your-api-token>
librenmsctrl status
librenmsctrl alerts list --state 1
librenmsctrl --json ports health --metric errors_in --limit 10
The MCP adapter speaks stdio. A quick way to confirm it starts is to feed it an MCP tools/list request:
export LIBRENMS_URL=https://librenms.example.local
export LIBRENMS_TOKEN=<your-api-token>
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | npx -y @solomonneas/librenms-mcp
You should get back a JSON listing of the 13 tools above. In normal use you point an MCP client at the same command instead.
Tools
The MCP adapter exposes 13 tools: 10 reads, 3 confirm-gated safe writes. This list is generated from the server's tool registration in mcp-server.ts.
Reads (10, open):
| Tool | What it does |
|---|---|
librenms_status |
LibreNMS instance status check. |
librenms_list_devices |
List monitored devices. |
librenms_get_device |
Fetch a single device by id. |
librenms_list_ports |
List ports across devices. |
librenms_get_port |
Fetch a single port detail. |
librenms_port_health |
Port health and utilization view. |
librenms_list_alerts |
List current alerts. |
librenms_get_alert |
Fetch a single alert by id. |
librenms_alert_history |
Historical alert records. |
librenms_event_log |
Read the device event log. |
Safe writes (3, require confirm: true):
| Tool | What it does |
|---|---|
librenms_ack_alert |
Acknowledge an active alert by id. |
librenms_unmute_alert |
Unmute a previously muted alert. |
librenms_set_maintenance |
Put a device into a maintenance window. |
Configuration
Set the following env vars. Both credential vars are required.
| Variable | Required | Default | Notes |
|---|---|---|---|
LIBRENMS_URL |
yes | - | Base URL of your LibreNMS instance. Trailing slashes are stripped. |
LIBRENMS_TOKEN |
yes | - | LibreNMS API token. Registered with the redactor on startup and masked from all output. |
LIBRENMS_TLS_INSECURE |
no | false |
Skip TLS cert validation for homelab self-signed certs. Accepts true/1/yes, case-insensitive. |
LIBRENMS_REQUEST_TIMEOUT_MS |
no | 30000 |
Per-request HTTP timeout in milliseconds. Minimum 1000. Raise for slow installations. |
CLI
librenmsctrl is the read-only operator control CLI for shells, cron, and CI. It shares the LibreNMS client core with the MCP adapter and talks to the same /api/v0 API over token auth. It exposes only the read tools (tier 1). The confirm-gated writes (ack, set_maintenance, unmute) are intentionally not surfaced in the CLI.
# installed globally as `librenmsctrl`, or via `npx -p @solomonneas/librenms-mcp librenmsctrl ...`
librenmsctrl status # instance health (exit 1 if no system data)
librenmsctrl devices list --type down
librenmsctrl devices get core-sw1
librenmsctrl ports list core-sw1
librenmsctrl ports get 42
librenmsctrl ports health --metric errors_in --limit 10
librenmsctrl alerts list --state 1 # 0=ok, 1=active, 2=ack
librenmsctrl alerts get 7
librenmsctrl alerts history --device-id 3 --limit 25
librenmsctrl events list --limit 50
librenmsctrl --json status # raw JSON for piping
Run librenmsctrl help for the full flag list. It reads the same LIBRENMS_URL, LIBRENMS_TOKEN, LIBRENMS_TLS_INSECURE, and LIBRENMS_REQUEST_TIMEOUT_MS env vars as the server. Exit codes: 0 success, 1 runtime error (LibreNMS unreachable, call failed, or status with no system data), 2 usage error (unknown command/flag or bad value).
Starting the MCP server
librenmsctrl mcp (or the back-compat librenms-mcp bin) starts the stdio MCP server. If a launcher referenced the file path dist/mcp-server.js directly, point it at dist/mcp-bin.js (or dist/cli.js mcp). Launchers that use the librenms-mcp bin name need no change.
MCP client config
Copy-paste this into your MCP client. It is the canonical mcpServers shape used by Claude Desktop and Claude Code. Both LIBRENMS_URL and LIBRENMS_TOKEN are required.
{
"mcpServers": {
"librenms": {
"command": "npx",
"args": ["-y", "@solomonneas/librenms-mcp"],
"env": {
"LIBRENMS_URL": "https://librenms.example.local",
"LIBRENMS_TOKEN": "<your-api-token>",
"LIBRENMS_TLS_INSECURE": "false"
}
}
}
}
Claude Code
claude mcp add librenms -s user -- npx -y @solomonneas/librenms-mcp
Then export LIBRENMS_URL and LIBRENMS_TOKEN in your shell (~/.bashrc, ~/.zshrc) or pass --env flags on the claude mcp add line.
Claude Desktop
Add the mcpServers block above to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows).
Codex CLI
~/.codex/config.toml:
[mcp_servers.librenms]
command = "npx"
args = ["-y", "@solomonneas/librenms-mcp"]
[mcp_servers.librenms.env]
LIBRENMS_URL = "https://librenms.example.local"
LIBRENMS_TOKEN = "<your-api-token>"
LIBRENMS_TLS_INSECURE = "false"
OpenClaw
The plugin loads automatically once installed. Config goes in your ~/.openclaw/openclaw.json under plugins.entries.librenms (or use the bundled openclaw.plugin.json):
{
"plugins": {
"entries": {
"librenms": {
"package": "@solomonneas/librenms-mcp",
"activation": { "onStartup": true }
}
}
}
}
Env vars from ~/.openclaw/workspace/.env are inherited by the plugin.
Safety
This MCP uses a three-tier write-gating pattern:
- Tier 1 (reads): open. No confirm flag needed.
- Tier 2 (safe writes): require an explicit
confirm: truearg. The JSON schema documents this on every write tool. A tool call without the confirm flag throwsWriteGateErrorbefore any HTTP traffic. - Tier 3 (destructive): not implemented in v1. When added, ops like device deletion, alert-rule removal, and bulk port resets will also require
destructive: true.
Input validation: every tool call is validated against its published TypeBox inputSchema before the tool runs. Ids, port ids, device ids, limits, and the type/state filters are bounds- and enum-checked, so a malformed or injection-style argument (a non-integer id, an off-enum filter, an unexpected extra field) is rejected up front and never reaches a LibreNMS URL path or query string. Interpolated path and query values are URL-encoded as defense-in-depth.
API token scope: start with a "Read Only" token role in LibreNMS (Settings > API > New API Token > Read Only) and verify the read tools work end-to-end. Grade up to "Normal User" or "Global Read/Write" only after you have confirmed the redactor is masking your token in your transcripts and that the model is honoring the confirm gate. Tokens can be revoked instantly from the same Settings > API screen.
TLS: the LIBRENMS_TLS_INSECURE=true toggle exists for homelab self-signed certs. Leave it false in any environment with a real CA-signed cert.
HTTP responses: authenticated redirects are rejected. Configure the final LibreNMS API URL directly. The request deadline covers response headers and the entire body. Success and error bodies share a 10 MiB decoded byte cap. GET requests retain one retry for transport, malformed JSON, and server errors. Mutations are sent once because a failed response cannot prove the server did not apply the write. Check server state before manually repeating a failed write.
Returned data: device names, descriptions, alert text, syslog and event messages, object keys, and upstream errors are untrusted LibreNMS content. Embedded instructions do not authorize tool calls or writes. JSON output escapes marker characters in keys and values while preserving decoded fields and the existing result envelope. Truncation is reported by the output byte cap.
See SECURITY.md for the vulnerability-reporting policy.
How does the MCP adapter constrain API access?
You can hand an agent a generic HTTP tool and the LibreNMS API token, and for read-only exploration that works. The difference shows up the moment a write is possible:
- No write gate. A generic HTTP tool will happily
PUTorDELETEwhatever the model decides to send. librenms-mcp refuses every write unless the call carriesconfirm: true, and refuses destructive shapes entirely in v1. - No input validation. A raw API tool passes whatever the model produced straight into a URL. librenms-mcp bounds- and enum-checks every argument against a published schema and URL-encodes interpolated values before any request is built.
- Token leakage. A generic tool echoes request and response detail, including your token, into the transcript. librenms-mcp registers the token with a redactor on startup and masks it from all log and error output.
- Shaped tools beat one giant endpoint. Thirteen named, described tools give the model a far better surface to reason over than one
call this REST APItool with a free-form path argument.
What librenms-mcp is not
- It is not a LibreNMS replacement or a poller. It reads an existing LibreNMS instance over the API. It does not collect SNMP itself.
- It is not a dashboard. It returns structured tool data for an agent. For a NOC dashboard view, see watchtower.
- It does not delete devices, remove alert rules, or do bulk port resets. Tier-3 destructive operations are deliberately absent in v1.
- It is not a hosted service. It runs locally over stdio, talks only to the LibreNMS URL you configure, and starts no daemon.
Contributing
Patches welcome. See CONTRIBUTING.md for what lands easily, CODE_OF_CONDUCT.md, and the issue and PR templates under .github/. All public output should be scrubbed of personal hostnames, tokens, and real IPs.
License
MIT.
CLI API results and errors are labeled as untrusted LibreNMS data, escape display controls and delimiters, and fit within 64 KiB. JSON results include _external_data_notice. Oversized JSON results return truncated: true in place of the payload. Consumers should check that flag before using a result. API credentials are registered for redaction when a client is constructed.
Questions sur librenmsctrl MCP
Quels outils librenmsctrl MCP fournit-il ?
Il expose 13 outils, dont librenms_status, librenms_list_devices, librenms_get_device, librenms_list_ports, librenms_get_port.
Comment le serveur empêche-t-il les modifications accidentelles de mon état de surveillance ?
Le serveur utilise un modèle de contrôle d'écriture à trois niveaux où les écritures sécurisées nécessitent un argument explicite 'confirm: true' et toutes les entrées sont validées par un schéma avant l'exécution.
Quel type d'opérations d'écriture sont prises en charge dans la version 1 ?
La version 1 prend en charge les 'écritures sécurisées' telles que l'accusé de réception des alertes, la levée du mode muet des alertes et la mise en mode maintenance des appareils, mais les opérations destructives comme la suppression d'appareils ne sont pas encore implémentées.
Quelles variables d'environnement sont nécessaires pour exécuter le serveur ?
Vous devez configurer les variables LIBRENMS_URL et LIBRENMS_TOKEN pour vous connecter à votre instance.