How do I install the netbox mcp server?

Use a recorded configuration for your client, replace example credential values and paths, and verify the documented runtime. Restart or reconnect the client, then inspect the available tools.

What credentials does it need?

It reads `NETBOX_URL`, `NETBOX_TOKEN`, `ENABLE_PLUGIN_DISCOVERY`, `TRANSPORT`, `HOST`, `PORT`, `MCP_AUTH_TOKEN` from the environment. Store these in your client's env block or a secrets manager — never commit them to a repository — and grant the narrowest scope that still covers your use case.

SSyncDev

Start a project

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

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.

What it needs from you

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

More MCP options

Compare MCP servers by category, or browse hosted MCP servers if you prefer an endpoint over a local process.

Maintainer setup documentation.

Recorded tools

Check the linked publisher documentation and your connected client's tool list. Names and availability can vary with the server version and account permissions.

Tool	What it does
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

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

Variable	Description	Required
NETBOX_URL	Endpoint or connection string the server talks to.	Yes
NETBOX_TOKEN	Credential the server authenticates with.	Yes
ENABLE_PLUGIN_DISCOVERY	Configuration value read at startup.	Optional
TRANSPORT	Configuration value read at startup.	Optional
HOST	Endpoint or connection string the server talks to.	Optional
PORT	Configuration value read at startup.	Optional
MCP_AUTH_TOKEN	Credential 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

Model Context Protocol (MCP) server for read-only interaction with NetBox data in LLMs Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.