Netbox MCP Server

🚀 NetBox MCP Server

A simple read-only Model Context Protocol server for NetBox. It enables you to directly interact with your NetBox data through large language models (LLMs) that support MCP.

🚀 Quick Start

✨ Features

This server provides several useful tools to interact with NetBox data:

⚠️ Important Note

Currently, the supported object types are clearly defined and limited to core NetBox objects. Plugin object types are not supported for now.

📦 Installation

1. Create a read-only API token in NetBox and ensure it has sufficient permissions to access the data you want to provide via MCP.
2. Install dependencies: uv add -r requirements.txt

💻 Usage Examples

Basic Usage

1. Verify that the server can run: NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN=<your-api-token> uv run server.py
2. Add the MCP server configuration to your LLM client. For example, on 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>"
            }
        }
}

⚠️ Important Note

On Windows, use the full, escaped paths to point to your instance, such as C:\\Users\\myuser\\.local\\bin\\uv and C:\\Users\\myuser\\netbox-mcp-server. For detailed troubleshooting steps, refer to MCP Quick Start.

Advanced Usage

Use these tools in your LLM client. For example:

> Get all devices at the "Equinix DC14" site
...
> Tell me about my IPAM usage
...
> Which Cisco devices are in my network?
...
> Who made changes to the NYC site?
...
> Show all configuration changes of core routers in the past month

🤝 Development

Contributions are welcome! Please open an issue or submit a PR.

📄 License

This project is licensed under the Apache 2.0 license.