Netbox

Provides Netbox data access and MCP-enabled actions to automate cross-cloud workflows.

python

0

GitHub Stars

python

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "duckmak14-netbox-mcp": {
      "command": "python",
      "args": [
        "server.py"
      ],
      "env": {
        "NETBOX_URL": "YOUR_NETBOX_URL",
        "NETBOX_TOKEN": "YOUR_NETBOX_TOKEN"
      }
    }
  }
}

This MCP server lets you connect Netbox network infrastructure data with Multi-Cloud Platform actions, so you can manage devices, circuits, and related resources from Netbox while triggering cross-cloud workflows. It streamlines automation by exposing Netbox data to MCP clients and enabling MCP-driven actions against your Netbox-managed environment.

How to use

You will run the MCP server locally or in a container and connect an MCP client to it. Start the server with your preferred method, then configure your MCP client to target the server’s endpoint. Your client can perform MCP-enabled actions that operate on Netbox resources, allowing you to automate provisioning, updates, and workflows that involve Netbox data. Ensure your client has the necessary credentials to access Netbox through the server.

How to install

Prerequisites you need on your system are Docker and Docker Compose, plus Python 3.10 with a virtual environment tool.

# Prerequisites
apt install python3.10-venv

# Option 1: Local Installation
# 1. Clone the repository
git clone https://github.com/duckmak14/netbox-mcp.git
cd netbox-mcp

# 2. Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Configure environment variables
# Create a .env file in the project root with:
NETBOX_URL=your_netbox_url
NETBOX_TOKEN=your_api_token

# 5. Start the server
python server.py

# 6. Access the application at http://localhost:8000

# Option 2: Docker Installation
# 1. Clone the repository
git clone https://github.com/duckmak14/netbox-mcp.git
cd netbox-mcp

# 2. Configure environment variables
# Create a .env file in the project root with:
NETBOX_URL=your_netbox_url
NETBOX_TOKEN=your_api_token

# 3. Build and run with Docker Compose
# Note: Starting from Docker Compose version 2.0, use the docker compose command. For older versions, use docker-compose.

# Build and start the container in detached mode
docker compose up -d

# View logs
docker compose logs -f

# Stop the container
docker compose down

# Access the application at http://localhost:8000

Additional sections

Configuration notes, security considerations, and troubleshooting tips are included to help you run the MCP server reliably.

Environment variables shown for running the server include NETBOX_URL and NETBOX_TOKEN. Use these to connect to your Netbox instance and authenticate API requests.