NetBox MCP Server

By netboxlabs GitHub

Model Context Protocol (MCP) server for read-only interaction with NetBox data in LLMs

mcp netbox

Overview

what is NetBox MCP Server?

NetBox MCP Server is a read-only Model Context Protocol (MCP) server designed for interacting with NetBox data through LLMs (Large Language Models).

how to use NetBox MCP Server?

To use the NetBox MCP Server, create a read-only API token in NetBox, install the necessary dependencies, run the server with your NetBox URL and token, and configure your LLM client to use the MCP server.

key features of NetBox MCP Server?

Read-only access to NetBox data via LLMs
Tools for retrieving and searching NetBox objects
Simple setup and configuration for integration with LLM clients

use cases of NetBox MCP Server?

Retrieving device information from NetBox for network management.
Performing global searches for specific NetBox objects.
Accessing detailed information about NetBox objects by their ID.

FAQ from NetBox MCP Server?

What is the purpose of the NetBox MCP Server?

It allows users to interact with NetBox data in a read-only manner using LLMs that support the Model Context Protocol.

Is the NetBox MCP Server free to use?

Yes! The server is open-source and available under the Apache 2.0 license.

What types of objects can I access with the NetBox MCP Server?

Currently, it supports core NetBox objects only, and does not work with object types from plugins.

Content

NetBox MCP Server

This is a simple read-only Model Context Protocol server for NetBox. It enables you to interact with your data in NetBox directly via LLMs that support MCP.

Tools

Tool	Description
get_objects	Retrieves NetBox core objects based on their type and filters
get_object_by_id	Gets detailed information about a specific NetBox object by its ID
get_changelogs	Retrieves change history records (audit trail) based on filters

Note: the set of supported object types is explicitly defined and limited to the core NetBox objects for now, and won't work with object types from plugins.

Usage

Create a read-only API token in NetBox with sufficient permissions for the tool to access the data you want to make available via MCP.
Install dependencies: uv add -r requirements.txt
Verify the server can run: NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN=<your-api-token> uv run server.py
Add the MCP server configuration to your LLM client. For example, in Claude Desktop (Mac):

{
  "mcpServers": {
        "netbox": {
            "command": "uv",
            "args": [
                "--directory",
                "/path/to/netbox-mcp-server",
                "run",
                "server.py"
            ],
            "env": {
                "NETBOX_URL": "https://netbox.example.com/",
                "NETBOX_TOKEN": "<your-api-token>"
            }
        }
}

On Windows, use full, escaped path to your instance, such as C:\\Users\\myuser\\.local\\bin\\uv and C:\\Users\\myuser\\netbox-mcp-server. For detailed troubleshooting, consult the MCP quickstart.

Use the tools in your LLM client. For example:

> Get all devices in the 'Equinix DC14' site
...
> Tell me about my IPAM utilization
...
> What Cisco devices are in my network?
...
> Who made changes to the NYC site in the last week?
...
> Show me all configuration changes to the core router in the last month