netbox-mcp-server-extended

Write-enabled fork of netboxlabs/netbox-mcp-server. Tracks upstream automatically via weekly CI rebase. All original read-only tools are preserved unchanged.

Extended tools (this fork)

Three new tools, each with dry_run=True by default:

Tool	Description
netbox_create_object(object_type, data, dry_run=True)	Create any NetBox object
netbox_update_object(object_type, object_id, data, dry_run=True)	Partial-update any NetBox object
netbox_delete_object(object_type, object_id, dry_run=True)	Delete any NetBox object

All three accept the same object_type values as the read tools (100+ types).

Dry run is the default. Every write tool returns a _dry_run key with instructions when called without dry_run=False:

"_dry_run": "Validated by NetBox (executed with commit=false and rolled back — nothing was written). Call again with dry_run=False to execute."

Write tools: usage & safety

All three write tools default to dry_run=True. A dry run is executed by NetBox itself: the server runs the bundled MCPWriteValidator custom script with commit=false, so NetBox applies the change with its own REST serializers inside a transaction that is always rolled back — required fields, choices, uniqueness, and protected references are all checked, nothing persists, and no webhooks or event rules fire. Re-run with dry_run=False to commit through the regular REST API.

Dry runs require netbox_scripts/netbox_mcp_server_extended.py to be installed on the NetBox host (one file, no restart) and a running RQ worker. If either is missing, the dry run fails with instructions — it never falls back to performing the real write. (Earlier releases appended ?dry_run=true to real requests, a parameter stock NetBox ignores, which made "dry" runs execute; this release replaces that mechanism.)

Dry-run walkthrough

# 1. Dry run (default) — validated by NetBox, rolled back, nothing written
netbox_create_object(
    object_type="extras.tag",
    data={"name": "decommissioned", "slug": "decommissioned", "color": "9e9e9e"},
)
# → {
#     "valid": true,
#     "operation": "create", "object_type": "extras.tag",
#     "detail": "Would create extras.tag (decommissioned)",
#     "_dry_run": "Validated by NetBox (executed with commit=false and rolled back — nothing was written). Call again with dry_run=False to execute."
#   }
# An invalid payload returns {"valid": false, "errors": ["slug: This field is required."], ...}

# 2. Commit — same call with dry_run=False
netbox_create_object(
    object_type="extras.tag",
    data={"name": "decommissioned", "slug": "decommissioned", "color": "9e9e9e"},
    dry_run=False,
)
# → {"id": 42, "name": "decommissioned", "slug": "decommissioned", "color": "9e9e9e", ...}

The presence of the _dry_run key means nothing was written. Once you pass dry_run=False, the change is live.

Examples per tool

# Create — add a tag
netbox_create_object(
    object_type="extras.tag",
    data={"name": "decommissioned", "slug": "decommissioned", "color": "9e9e9e"},
    dry_run=False,
)

# Update — set a device's status to "offline"
# (partial update: only the supplied fields change)
netbox_update_object(
    object_type="dcim.device",
    object_id=123,
    data={"status": "offline"},
    dry_run=False,
)

# Delete — remove a prefix by ID
netbox_delete_object(
    object_type="ipam.prefix",
    object_id=456,
    dry_run=False,
)
# → {"deleted": true, "object_type": "ipam.prefix", "object_id": 456}

object_type accepts the same dotted app_label.model values as the read tools (e.g. extras.tag, dcim.device, ipam.prefix). Calling a write tool with an invalid type returns the full list of valid types.

NetBox compatibility

• Read tools (inherited from upstream): NetBox 4.1+ (netbox_get_changelogs needs the 4.1 core/object-changes endpoint; plugin discovery needs 4.2+).
• Write tools and dry runs: NetBox 4.0–4.7, verified against the newest tag of each minor line. On 4.0.x a failing dry run reports job status failed rather than completed; the client accepts both.
• Dry-run rollback is guaranteed on every supported release, but on NetBox 4.1.9–4.1.11 and 4.2.0–4.2.4 event rules/webhooks may still fire for the rolled-back changes (a NetBox-side gap in event suppression, fixed in 4.2.5). Avoid dry runs on those releases if webhooks are configured.
• On NetBox 4.6.8+ and 4.7, running scripts over the REST API requires a token with write ability — this also applies to dry runs.
• Core custom scripts are deprecated in NetBox 4.7 and scheduled for removal in 5.0 (~May 2027); the dry-run backend will move to NetBox's replacement plugin when it lands. This is tracked as an open feature request in issue #39.

Safety guidance

• Use a read-only token unless you need writes. The write tools require a NetBox token with write permissions; if you only query data, keep using a read-only token so the tools physically cannot change anything.
• Scope write tokens narrowly. Grant only the object permissions you actually intend to modify.
• Always dry-run first. Leave dry_run=True (the default) for the initial call, review the returned verdict (valid, detail, and errors), then repeat with dry_run=False. This is the recommended workflow for LLM-driven changes: the model proposes a change, you inspect the dry-run result, then approve the commit.
• Deletes are irreversible. A dry run of an update or a delete repeats the object_id it validated, and detail names the object (e.g. "Would delete dcim.device id=5 (core-sw-01)"). Confirm both before you commit.
• A valid dry run is not an authorization check. The validator script reaches the database directly, so it does not apply NetBox's object-level permissions. A dry run can return valid: true for a change that the real write then rejects with HTTP 403. The error direction is safe — the real write still enforces the token's permissions — but do not read valid: true as proof that the token may perform the change.

Enabling write tools in Claude Code

The write tools register automatically when the server starts — no extra flag is needed. Add the extended server with a write-capable token:

claude mcp add --transport stdio netbox \
  --env NETBOX_URL=https://netbox.example.com/ \
  --env NETBOX_TOKEN=<your-write-token> \
  -- uv --directory /path/to/netbox-mcp-server-extended run netbox-mcp-server-extended

Or in a Claude Desktop / MCP client config file:

{
    "mcpServers": {
        "netbox": {
            "command": "uv",
            "args": [
                "--directory",
                "/path/to/netbox-mcp-server-extended",
                "run",
                "netbox-mcp-server-extended"
            ],
            "env": {
                "NETBOX_URL": "https://netbox.example.com/",
                "NETBOX_TOKEN": "<your-write-token>"
            }
        }
    }
}

After adding, verify with /mcp in Claude Code — you should see netbox_create_object, netbox_update_object, and netbox_delete_object alongside the read tools.

Versioning

Releases follow PEP 440 post-release: 1.1.0.post1, 1.1.0.post2, etc. When upstream releases a new version, the .post counter resets: 1.2.0.post1. The part before .post is the upstream release this fork is built on, so 1.2.1.post2 is the second fork-layer release on upstream v1.2.1.

A merge to main does not publish anything. Maintainers release through one of two GitHub Actions workflows, and each one pushes a v*.post* tag that builds the GitHub Release, the PyPI package, and the GHCR image:

• Sync Upstream — runs every Monday and on demand. It rebases the fork layer onto a new upstream tag and resets the counter to .post1.
• Release Fork Layer — run on demand when only the fork layer changed. It increments the counter, for example 1.2.1.post1 to 1.2.1.post2.

---

NetBox MCP Server

⚠️ Breaking Change in v1.0.0: The project structure has changed. If upgrading from v0.1.0, update your configuration:

• Change uv run server.py to uv run netbox-mcp-server
• Update Claude Desktop/Code configs to use netbox-mcp-server instead of server.py
• Docker users: rebuild images with updated CMD
• See CHANGELOG.md for full details

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.

The server is intentionally simple: easy to get started with, hard to misuse (read-only by default, no plugin surface), and easy to fork and adapt. Forking under Apache 2.0 is a first-class path for users who need capabilities beyond the project's scope.

Community

For chat, use cases, and general MCP discussion, join the NetBox community at netdev.chat. The #ai channel is the right home for MCP integrations, questions, and sharing use cases. Bugs and feature ideas specific to this server go in issues.

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: Core NetBox object types are always available. Plugin object types can be auto-discovered. See Plugin Object Type Discovery. Advanced features (GraphQL, dynamic model discovery, etc.) are deliberately out of scope. See CONTRIBUTING.md for the full scope statement and rationale.

Usage

1. 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.

2. Install dependencies:

   # Using UV (recommended)
   uv sync
   
   # Or using pip
   pip install -e .
   

3. Verify the server can run: NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN=<your-api-token> uv run netbox-mcp-server-extended

4. Add the MCP server to your LLM client. See below for some examples with Claude.

Claude Code

Stdio Transport (Default)

Add the server using the claude mcp add command:

claude mcp add --transport stdio netbox \
  --env NETBOX_URL=https://netbox.example.com/ \
  --env NETBOX_TOKEN=<your-api-token> \
  -- uv --directory /path/to/netbox-mcp-server run netbox-mcp-server-extended

Important notes:

• Replace /path/to/netbox-mcp-server with the absolute path to your local clone
• The -- separator distinguishes Claude Code flags from the server command
• Use --scope project to share the configuration via .mcp.json in version control
• Use --scope user to make it available across all your projects (default is local)

After adding, verify with /mcp in Claude Code or claude mcp list in your terminal.

HTTP Transport

For HTTP transport, first start the server manually:

# Start the server with HTTP transport (using .env or environment variables)
NETBOX_URL=https://netbox.example.com/ \
NETBOX_TOKEN=<your-api-token> \
TRANSPORT=http \
uv run netbox-mcp-server-extended

Then add the running server to Claude Code:

# Add the HTTP MCP server (note: URL must include http:// or https:// prefix)
claude mcp add --transport http netbox http://127.0.0.1:8000/mcp

Important notes:

• The URL must include the protocol prefix (http:// or https://)
• The default endpoint is /mcp when using HTTP transport
• The server must be running before Claude Code can connect
• Verify the connection with claude mcp list - you should see a ✓ next to the server name

Claude Desktop

Add the server configuration to your Claude Desktop config file. On Mac, edit ~/Library/Application Support/Claude/claude_desktop_config.json:

{
    "mcpServers": {
        "netbox": {
            "command": "uv",
            "args": [
                "--directory",
                "/path/to/netbox-mcp-server",
                "run",
                "netbox-mcp-server-extended"
            ],
            "env": {
                "NETBOX_URL": "https://netbox.example.com/",
                "NETBOX_TOKEN": "<your-api-token>"
            }
        }
    }
}

On Windows, use full, escaped path to your instance, such as C:\\Users\\myuser\\.local\\bin\\uv and C:\\Users\\myuser\\netbox-mcp-server. For detailed troubleshooting, consult the MCP quickstart.

5. 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

Field Filtering (Token Optimization)

Both netbox_get_objects() and netbox_get_object_by_id() support an optional fields parameter to reduce token usage:

# Without fields: ~5000 tokens for 50 devices
devices = netbox_get_objects('devices', {'site': 'datacenter-1'})

# With fields: ~500 tokens (90% reduction)
devices = netbox_get_objects(
    'devices',
    {'site': 'datacenter-1'},
    fields=['id', 'name', 'status', 'site']
)

Common field patterns:

• Devices: ['id', 'name', 'status', 'device_type', 'site', 'primary_ip4']
• IP Addresses: ['id', 'address', 'status', 'dns_name', 'description']
• Interfaces: ['id', 'name', 'type', 'enabled', 'device']
• Sites: ['id', 'name', 'status', 'region', 'description']

The fields parameter uses NetBox's native field filtering. See the NetBox API documentation for details.

Configuration

The server supports multiple configuration sources with the following precedence (highest to lowest):

1. Command-line arguments (highest priority)
2. Environment variables
3. .env file in the project root
4. Default values (lowest priority)

Configuration Reference

Setting	Type	Default	Required	Description
NETBOX_URL	URL	-	Yes	Base URL of your NetBox instance (e.g., https://netbox.example.com/)
NETBOX_TOKEN	String	-	Yes	API token for authentication
TRANSPORT	stdio | http	stdio	No	MCP transport protocol
HOST	String	127.0.0.1	If HTTP	Host address for HTTP server
PORT	Integer	8000	If HTTP	Port for HTTP server
MCP_AUTH_TOKEN	String	-	No	Bearer token required on the HTTP endpoint. When unset, the HTTP transport is unauthenticated. Clients send Authorization: Bearer <token>.
VERIFY_SSL	Boolean	true	No	Whether to verify SSL certificates
ENABLE_PLUGIN_DISCOVERY	Boolean	false	No	Auto-discover plugin object types at startup
DRY_RUN_SCRIPT	String	netbox_mcp_server_extended.MCPWriteValidator	No	NetBox custom script (<module>.<ClassName>) executed with commit=false to back write-tool dry runs. See netbox_scripts/README.md.
DRY_RUN_TIMEOUT	Number	60	No	Seconds to wait for a dry-run script job to finish
LOG_LEVEL	DEBUG | INFO | WARNING | ERROR | CRITICAL	INFO	No	Logging verbosity

Transport Examples

Stdio Transport (Claude Desktop/Code)

For local Claude Desktop or Claude Code usage with stdio transport:

{
    "mcpServers": {
        "netbox": {
            "command": "uv",
            "args": ["--directory", "/path/to/netbox-mcp-server", "run", "netbox-mcp-server-extended"],
            "env": {
                "NETBOX_URL": "https://netbox.example.com/",
                "NETBOX_TOKEN": "<your-api-token>"
            }
        }
    }
}

HTTP Transport (Web Clients)

For web-based MCP clients using HTTP/SSE transport:

# Using environment variables
export NETBOX_URL=https://netbox.example.com/
export NETBOX_TOKEN=<your-api-token>
export TRANSPORT=http
export HOST=127.0.0.1
export PORT=8000

uv run netbox-mcp-server-extended

# Or using CLI arguments
uv run netbox-mcp-server-extended \
  --netbox-url https://netbox.example.com/ \
  --netbox-token <your-api-token> \
  --transport http \
  --host 127.0.0.1 \
  --port 8000

Example .env File

Create a .env file in the project root:

# Core NetBox Configuration
NETBOX_URL=https://netbox.example.com/
NETBOX_TOKEN=your_api_token_here

# Transport Configuration (optional, defaults to stdio)
TRANSPORT=stdio

# HTTP Transport Settings (only used if TRANSPORT=http)
# HOST=127.0.0.1
# PORT=8000
# Bearer token required on the HTTP endpoint. When unset, the endpoint is unauthenticated.
# MCP_AUTH_TOKEN=a-strong-random-token

# Security (optional, defaults to true)
VERIFY_SSL=true

# Plugin Discovery (optional, defaults to false)
# ENABLE_PLUGIN_DISCOVERY=true

# Logging (optional, defaults to INFO)
LOG_LEVEL=INFO

CLI Arguments

All configuration options can be overridden via CLI arguments:

uv run netbox-mcp-server-extended --help

# Common examples:
uv run netbox-mcp-server-extended --log-level DEBUG --no-verify-ssl  # Development
uv run netbox-mcp-server-extended --transport http --port 9000       # Custom HTTP port

Docker Usage

Pre-built Image (GHCR) — recommended

This fork publishes pre-built multi-arch images (linux/amd64, linux/arm64) to the GitHub Container Registry. Pull and run without cloning the repo:

docker pull ghcr.io/thomaschristory/netbox-mcp-server-extended:latest

docker run --rm \
  -e NETBOX_URL=https://netbox.example.com/ \
  -e NETBOX_TOKEN=<your-api-token> \
  -e TRANSPORT=http \
  -e HOST=0.0.0.0 \
  -e ALLOW_UNAUTHENTICATED_HTTP=true \
  -e PORT=8000 \
  -e MCP_AUTH_TOKEN=<a-strong-random-token> \
  -p 8000:8000 \
  ghcr.io/thomaschristory/netbox-mcp-server-extended:latest

Note: Docker containers require TRANSPORT=http since stdio transport doesn't work in containerized environments.

⚠️ Security: The HTTP transport has no authentication unless you set MCP_AUTH_TOKEN (clients then send Authorization: Bearer <token>). Because this fork also exposes write tools backed by a privileged NetBox token, binding HTTP to a non-loopback address (such as 0.0.0.0 in a container) is refused unless you also set ALLOW_UNAUTHENTICATED_HTTP=true to acknowledge the risk. For any network-exposed deployment set a strong MCP_AUTH_TOKEN and terminate TLS at a reverse proxy — a bearer token sent over plain HTTP can be intercepted. Use a read-only NetBox token unless you specifically need the write tools.

Available tags:

Tag	Description
:latest	Most recent build from the default branch
:main	Latest build of the main branch
:sha-<short>	Immutable build for a specific commit (e.g. :sha-4f06758)
:X.Y.Z, :X.Y, :X	Semantic-version tags published on releases

Pin to a specific version or commit SHA in production — :latest and :main track the newest build and can change without notice.

Connecting to NetBox on your host machine:

If your NetBox instance is running on your host machine (not in a container), use host.docker.internal instead of localhost on macOS and Windows:

# For NetBox running on host (macOS/Windows)
docker run --rm \
  -e NETBOX_URL=http://host.docker.internal:18000/ \
  -e NETBOX_TOKEN=<your-api-token> \
  -e TRANSPORT=http \
  -e HOST=0.0.0.0 \
  -e ALLOW_UNAUTHENTICATED_HTTP=true \
  -e PORT=8000 \
  -e MCP_AUTH_TOKEN=<a-strong-random-token> \
  -p 8000:8000 \
  ghcr.io/thomaschristory/netbox-mcp-server-extended:latest

Note: On Linux, you can use --network host instead, or use the host's IP address directly.

With additional configuration options:

docker run --rm \
  -e NETBOX_URL=https://netbox.example.com/ \
  -e NETBOX_TOKEN=<your-api-token> \
  -e TRANSPORT=http \
  -e HOST=0.0.0.0 \
  -e ALLOW_UNAUTHENTICATED_HTTP=true \
  -e MCP_AUTH_TOKEN=<a-strong-random-token> \
  -e LOG_LEVEL=DEBUG \
  -e VERIFY_SSL=false \
  -p 8000:8000 \
  ghcr.io/thomaschristory/netbox-mcp-server-extended:latest

The server will be accessible at http://localhost:8000/mcp for MCP clients. You can connect to it using your preferred method.

Build from Source

To build the image yourself (for local development or customisation):

# Build the image
docker build -t netbox-mcp-server-extended:latest .

# Run it (same environment variables as the pre-built image above)
docker run --rm \
  -e NETBOX_URL=https://netbox.example.com/ \
  -e NETBOX_TOKEN=<your-api-token> \
  -e TRANSPORT=http \
  -e HOST=0.0.0.0 \
  -e ALLOW_UNAUTHENTICATED_HTTP=true \
  -e PORT=8000 \
  -p 8000:8000 \
  netbox-mcp-server-extended:latest

Plugin Object Type Discovery

By default, only core NetBox object types are available. If your NetBox instance has plugins installed (e.g., netbox-dns, netbox-inventory), you can enable automatic discovery to make their object types available as well.

Enabling Discovery

Set the ENABLE_PLUGIN_DISCOVERY environment variable or use the --enable-plugin-discovery CLI flag:

# Via environment variable
ENABLE_PLUGIN_DISCOVERY=true uv run netbox-mcp-server-extended

# Via CLI flag
uv run netbox-mcp-server-extended --enable-plugin-discovery

# In Claude Desktop config
{
    "mcpServers": {
        "netbox": {
            "command": "uv",
            "args": ["--directory", "/path/to/netbox-mcp-server", "run", "netbox-mcp-server-extended"],
            "env": {
                "NETBOX_URL": "https://netbox.example.com/",
                "NETBOX_TOKEN": "<your-api-token>",
                "ENABLE_PLUGIN_DISCOVERY": "true"
            }
        }
    }
}

How It Works

At startup, the server queries NetBox's core/object-types API endpoint (with extras/object-types fallback for NetBox < 4.4) to find all installed plugin models that have REST API endpoints. These are merged into the runtime type registry alongside the core types.

Discovered plugin types use the app_label.model naming convention (e.g., netbox_dns.zone, netbox_inventory.asset) and work with all existing tools (netbox_get_objects, netbox_get_object_by_id, netbox_search_objects).

Requirements

• 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

Failure Behavior

If discovery fails for any reason (network error, insufficient permissions, unsupported NetBox version), the server logs a warning and continues with core types only. This ensures the server always starts successfully regardless of discovery outcome.

Development

Contributions are welcome! Please read CONTRIBUTING.md before proposing new features. We encourage filing an issue for discussion first to confirm scope fit.

If your use case needs capabilities outside this project's scope, forking under Apache 2.0 is an actively supported path.

License

This project is licensed under the Apache 2.0 license. See the LICENSE file for details.