NetBox MCP Server

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

Local serverstdioPython

What is the NetBox MCP server?

Model Context Protocol (MCP) server for read-only interaction with NetBox data in LLMs. That is what the netbox mcp server brings to an AI assistant: the same capability, reachable through the Model Context Protocol rather than a separate app or dashboard.

The short version

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.

The tools it exposes

The server publishes 4 tools. What each one is for:

  • 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
  • Requirements — The Requirements tool exposed by this server

Getting it running

Setup follows the usual MCP pattern — install or clone the server, register it in your client's configuration file, restart the client. The configuration blocks on this page cover the common clients.

What it needs from you

Configuration is passed through the environment: NETBOX_URL, NETBOX_TOKEN, ENABLE_PLUGIN_DISCOVERY, TRANSPORT, HOST, PORT, MCP_AUTH_TOKEN. Treat anything key-shaped as a real credential — scope it to the minimum the server needs, and rotate it if it ever lands in a shared config.

  • NetBox 4.2 or later - API token must have read access to the object-types endpoint - Plugin models must expose a REST API endpoint to be discovered

How it compares

Plenty of developer tooling servers cover similar ground. The differences that matter in practice are scope of access and how much setup stands between you and a working tool call. NetBox's toolset — get_objects, get_object_by_id, get_changelogs and 1 more — is a fair guide to whether it matches your workflow. It is maintained by netboxlabs; worth a glance at recent repository activity before you build anything load-bearing on it.

SyncDev reviews every entry in this directory against the project's own documentation before publishing, and revisits them as servers change.

Things to watch

  • It runs with your machine's permissions. That is convenient and also the reason to think about what you point it at before you approve a tool call.
  • Missing credentials fail quietly in some clients — if no tools show up, check the environment block first.
  • Keep per-call confirmation enabled while you learn its behaviour; it is the cheapest safeguard you have.

Available tools

ToolWhat it does
get_objectsRetrieves NetBox core objects based on their type and filters
get_object_by_idGets detailed information about a specific NetBox object by its ID
get_changelogsRetrieves change history records (audit trail) based on filters
RequirementsThe Requirements tool exposed by this server.

How to install the NetBox MCP server

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

Configuration as documented by the project. Restart the client after saving.

Configuration

  • NetBox 4.2 or later - API token must have read access to the object-types endpoint - Plugin models must expose a REST API endpoint to be discovered
VariableDescriptionRequired
NETBOX_URLEndpoint or connection string the server talks to.Yes
NETBOX_TOKENCredential the server authenticates with.Yes
ENABLE_PLUGIN_DISCOVERYConfiguration value read at startup.Optional
TRANSPORTConfiguration value read at startup.Optional
HOSTEndpoint or connection string the server talks to.Optional
PORTConfiguration value read at startup.Optional
MCP_AUTH_TOKENCredential the server authenticates with.Yes

Example prompts to try

  • Use NetBox to get objects.
  • Use NetBox to get object by id.
  • Use NetBox to get changelogs.

Frequently asked questions

It connects NetBox to MCP-compatible AI assistants such as Claude and Cursor, exposing 4 tools (get_objects, get_object_by_id, get_changelogs, and more) that the assistant can call on your behalf. Instead of copying data back and forth by hand, the assistant works with NetBox directly.