librenms-mcp

# LibreNMS MCP Server

<!-- mcp-name: io.github.mhajder/librenms-mcp -->

LibreNMS MCP Server is a Python-based Model Context Protocol (MCP) server designed to provide advanced, programmable access to LibreNMS network monitoring data and management features. It exposes a modern API for querying, automating, and integrating LibreNMS resources such as devices, ports, alerts, inventory, locations, logs, and more. The server supports both read and write operations, robust security features, and is suitable for integration with automation tools, dashboards, and custom network management workflows.

## Features

### Core Features

- Query LibreNMS devices, ports, inventory, locations, logs, and alerts with flexible filtering
- Retrieve network topology, device status, and performance metrics
- Access and analyze alert history, event logs, and system health
- Monitor interface statistics, port status, and traffic data
- Track endpoints and connected devices by MAC or IP address
- Retrieve and manage device groups, port groups, and poller groups
- Get detailed information about network services and routing

### Management Operations

- Create, update, and delete devices, ports, and groups (if enabled)
- Manage alert rules, notifications, and device metadata
- Configure read-only mode to restrict all write operations for safe monitoring
- Support for bulk operations on devices and ports

### Advanced Capabilities

- Rate limiting and API security features
- Real-time network monitoring and health tracking
- Comprehensive logging and audit trails
- SSL/TLS support and configurable timeouts
- Optional tool-search transform for large tool catalogs
- Extensible with custom middlewares and utilities

## Installation

### Prerequisites

- Python 3.11 to 3.14
- Access to a LibreNMS
- Valid LibreNMS token with appropriate permissions

### Quick Install from PyPI

The easiest way to get started is to install from PyPI:

```sh
# Using UV (recommended)
uvx librenms-mcp

# Or using pip
pip install librenms-mcp
```

Remember to configure the environment variables for your LibreNMS instance before running the server:

```sh
# Create environment configuration
export LIBRENMS_URL=https://domain.tld:8443
export LIBRENMS_TOKEN=your-librenms-token
```

For more details, visit: https://pypi.org/project/librenms-mcp/

### Install from Source

1. Clone the repository:

```sh
git clone https://github.com/mhajder/librenms-mcp.git
cd librenms-mcp
```

2. Install dependencies:

```sh
# Using UV (recommended)
uv sync

# Or using pip
pip install -e .
```

3. Configure environment variables:

```sh
cp .env.example .env
# Edit .env with your LibreNMS url and token
```

4. Run the server:

```sh
# Using UV (recommended)
uv run librenms-mcp

# Or using the installed command directly
librenms-mcp
```

### Using Docker

A Docker images are available on GitHub Packages for easy deployment.

```sh
# Normal STDIO image
docker pull ghcr.io/mhajder/librenms-mcp:latest

# MCPO image for usage with Open WebUI
docker pull ghcr.io/mhajder/librenms-mcpo:latest
```

### Development Setup

For development with additional tools:

```sh
# Clone and install with development dependencies
git clone https://github.com/mhajder/librenms-mcp.git
cd librenms-mcp
uv sync --group dev

# Run tests
uv run pytest

# Run with coverage
uv run pytest --cov=src/

# Run linting and formatting
uv run ruff check .
uv run ruff format .

# Run type checking
uv run ty check .

# Setup pre-commit hooks
uv run prek install
```

## Configuration

### Environment Variables

```env
# LibreNMS Connection Details
LIBRENMS_URL=https://domain.tld:8443
LIBRENMS_TOKEN=your-librenms-token

# SSL Configuration
LIBRENMS_VERIFY_SSL=true
LIBRENMS_TIMEOUT=30

# Read-Only Mode
# Set READ_ONLY_MODE true to disable all write operations (put, post, delete)
READ_ONLY_MODE=false

# Disabled Tags
# Comma-separated list of tags to disable tools for (empty by default)
# Example: DISABLED_TAGS=alert,bills
DISABLED_TAGS=

# Logging Configuration
LOG_LEVEL=INFO

# Rate Limiting (requests per minute)
# Set RATE_LIMIT_ENABLED true to enable rate limiting
RATE_LIMIT_ENABLED=false
RATE_LIMIT_MAX_REQUESTS=100
RATE_LIMIT_WINDOW_MINUTES=1

# Tool Search Transform (Optional)
# Set TOOL_SEARCH_ENABLED true to replace full tool listings with search_tools + call_tool
TOOL_SEARCH_ENABLED=false
# Search strategy: bm25 (natural language) or regex (pattern match)
TOOL_SEARCH_STRATEGY=bm25
# Maximum number of tools returned by search_tools
TOOL_SEARCH_MAX_RESULTS=5

# Sentry Error Tracking (Optional)
# Set SENTRY_DSN to enable error tracking and performance monitoring
# SENTRY_DSN=https://your-key@o12345.ingest.us.sentry.io/6789
# Optional Sentry configuration
# SENTRY_TRACES_SAMPLE_RATE=1.0
# SENTRY_SEND_DEFAULT_PII=true
# SENTRY_ENVIRONMENT=production
# SENTRY_RELEASE=1.2.3
# SENTRY_PROFILE_SESSION_SAMPLE_RATE=1.0
# SENTRY_PROFILE_LIFECYCLE=trace
# SENTRY_ENABLE_LOGS=true

# MCP Transport Configuration
# Transport type: 'stdio' (default), 'sse' (Server-Sent Events), or 'http' (HTTP Streamable)
MCP_TRANSPORT=stdio

# HTTP Transport Settings (used when MCP_TRANSPORT=sse or MCP_TRANSPORT=http)
# Host to bind the HTTP server (default: 127.0.0.1)
# MCP_HTTP_HOST=127.0.0.1
# Port to bind the HTTP server (default: 8000)
# MCP_HTTP_PORT=8000
# Optional bearer token for authentication (leave empty for no auth)
# MCP_HTTP_BEARER_TOKEN=
```

## Available Tools

### Device & Inventory Tools

- `devices_list`: List all devices (with optional filters)
- `device_get`: Get details for a specific device
- `device_add`: Add a new device
- `device_update`: Update device metadata
- `device_delete`: Remove a device
- `device_ports`: List all ports for a device
- `device_ports_get`: Get details for a specific port on a device
- `device_fdb`: List the forwarding database (learned MACs) for a device
- `device_nac`: List network access control (802.1X / MAB) sessions on a device
- `device_availability`: Get device availability
- `device_outages`: Get device outages
- `device_set_maintenance`: Set device maintenance mode
- `device_discover`: Discover or add a device using provided credentials
- `device_rename`: Rename an existing device
- `device_maintenance_status`: Get the maintenance status for a device
- `device_vlans`: List VLANs for a device
- `device_links`: List links for a device
- `device_eventlog_add`: Add an event log entry for a device
- `inventory_device`: Get inventory for a device
- `inventory_device_flat`: Get flat inventory for a device
- `devicegroups_list`: List device groups
- `devicegroup_add`: Add a device group
- `devicegroup_update`: Update a device group
- `devicegroup_delete`: Delete a device group
- `devicegroup_devices`: List devices in a device group
- `devicegroup_set_maintenance`: Set maintenance for a device group
- `devicegroup_add_devices`: Add devices to a device group
- `devicegroup_remove_devices`: Remove devices from a device group
- `locations_list`: List all locations
- `location_add`: Add a location
- `location_edit`: Edit a location
- `location_delete`: Delete a location
- `location_get`: Get details for a location
- `location_set_maintenance`: Set maintenance for a location

### Port & Port Group Tools

- `ports_list`: List all ports (with optional filters)
- `ports_search`: Search ports (general search)
- `ports_search_field`: Search ports by a specific field
- `ports_search_mac`: Search ports by MAC address
- `port_get`: Get details for a specific port
- `port_fdb`: List MAC addresses learned on a port
- `port_ip_info`: Get IP address information for a port
- `port_transceiver`: Get transceiver information for a port
- `port_description_get`: Get a port description
- `port_description_update`: Update a port description
- `port_groups_list`: List port groups
- `port_group_add`: Add a port group
- `port_group_list_ports`: List ports in a port group
- `port_group_assign`: Assign ports to a port group
- `port_group_remove`: Remove ports from a port group

### Port Security Tools

- `port_security_list`: List port security configuration across all devices
- `port_security_device`: Get port security configuration for a device
- `port_security_port`: Get port security configuration for a single port

### Graph Tools

Graphs are returned as MCP images. LibreNMS serves SVG on current releases and
PNG on older ones; the MIME type is taken from the response.

- `device_graphs_list`: List the graph types available for a device
- `device_graph`: Render a device-level graph (e.g. `device_icmp_perf`)
- `port_graph`: Render a per-port graph by interface name (`bits`, `upkts`, `errors`, `etherlike`)
- `port_group_graph`: Render a traffic graph for one or more ports by port ID

`port_graph` falls back to the port-group endpoint for `bits` when the per-port
endpoint fails, which works around LibreNMS releases that return a 500 naming an
empty graph type.

### Alerting & Logging Tools

- `alerts_get`: List current and historical alerts
- `alert_get_by_id`: Get details for a specific alert
- `alert_acknowledge`: Acknowledge an alert
- `alert_unmute`: Unmute an alert
- `alert_rules_list`: List alert rules
- `alert_rule_get`: Get details for a specific alert rule
- `alert_rule_add`: Add an alert rule
- `alert_rule_edit`: Edit an alert rule
- `alert_rule_delete`: Delete an alert rule
- `alert_templates_list`: List all alert templates
- `alert_template_get`: Get a specific alert template
- `alert_template_create`: Create a new alert template
- `alert_template_edit`: Edit an alert template
- `logs_eventlog`: Get event log for a device
- `logs_syslog`: Get syslog for a device
- `logs_alertlog`: Get alert log for a device
- `logs_authlog`: Get auth log for a device
- `logs_syslogsink`: Add a syslog sink

### Billing Tools

- `bills_list`: List bills
- `bill_get`: Get details for a bill
- `bill_graph`: Render a bill graph as an image
- `bill_graph_data`: Get bill graph data
- `bill_history`: Get bill history
- `bill_history_graph`: Render