Netbox Mcp Server
What is Netbox Mcp Server
netbox-mcp-server is a read-only Model Context Protocol (MCP) server designed for interacting with NetBox data through Large Language Models (LLMs) that support MCP.
Use cases
Use cases for netbox-mcp-server include querying device information, checking IP address management utilization, and searching for specific network devices within a NetBox instance.
How to use
To use netbox-mcp-server, create a read-only API token in NetBox, install the required dependencies, run the server with your NetBox URL and API token, and configure your LLM client to connect to the MCP server.
Key features
Key features include retrieving NetBox core objects, performing global searches across NetBox objects, and obtaining detailed information about specific NetBox objects by their ID.
Where to use
undefined
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
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 Large Language Models (LLMs) that support MCP.
Use cases
Use cases for netbox-mcp-server include querying device information, checking IP address management utilization, and searching for specific network devices within a NetBox instance.
How to use
To use netbox-mcp-server, create a read-only API token in NetBox, install the required dependencies, run the server with your NetBox URL and API token, and configure your LLM client to connect to the MCP server.
Key features
Key features include retrieving NetBox core objects, performing global searches across NetBox objects, and obtaining detailed information about specific NetBox objects by their ID.
Where to use
undefined
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
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):
On Windows, use full, escaped path to your instance, such as
C:\\Users\\myuser\\.local\\bin\\uvandC:\\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
Development
Contributions are welcome! Please open an issue or submit a PR.
License
This project is licensed under the Apache 2.0 license. See the LICENSE file for details.
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
