mcp-netbox

# mcp-netbox A [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that exposes a [NetBox](https://netbox.io) DCIM/IPAM instance as a set of **read-only** tools. It lets an LLM (e.g. Claude, Copilot, or any MCP client) explore sites, regions, locations, devices, interfaces, racks, IP prefixes, IP addresses, VLANs, VRFs, ASNs, circuits, providers, clusters, virtual machines, tenants, and DNS zones/records (via the `netbox-dns` plugin). Built with [FastMCP](https://github.com/jlowin/fastmcp) and `httpx`. ## Features - **Read-only & safe** — every tool is annotated `read_only` / non-destructive / idempotent. No writes are ever performed. - **Dedicated tools** for the most common resources, plus **generic tools** (`netbox_list_objects`, `netbox_get_object`) that reach *any* NetBox API endpoint. - **Two output formats** — human-readable Markdown tables or machine-readable JSON, selectable per call. - **Pagination** — `limit` / `offset` on every list tool, with a hint about the next page when more results exist. - **Rich filtering** — per-resource filters (site, region, status, VRF, VLAN, manufacturer, …) plus a free-form `query_params` map on the generic tool. - **Config via file or environment** — `config.yaml` with environment overrides for secrets. ## Configuration The server reads a `config.yaml` file. Copy the provided example and fill in your values: ```bash cp config.example.yaml config.yaml ``` ```yaml netbox: url: https://netbox.example.com token: Token your-api-token-here timeout: 30000 # milliseconds verify_ssl: true ``` The config file is located in this order: 1. The `--config` command-line argument (if provided). 2. The path in the `NETBOX_CONFIG` environment variable. 3. `config.yaml` in the current working directory. 4. `config.yaml` next to the `mcp_netbox` package (the project root). Environment variables override the file values (handy for secrets): | Variable | Meaning …