AgentHubAgentHub

NetBox MCP Setup & Guide

MCP ServerMCP RegistryOfficial

io.github.mhajder/netbox-mcp · v0.1.0

MCP server for NetBox DCIM/IPAM with read-only and dry-run modes

Copy the install config on this page first, then verify docs and permissions upstream.

Overview

MCP server for NetBox DCIM/IPAM with read-only and dry-run modes NetBox MCP is a MCP Server listed from MCP Registry. Transports: stdio, streamable-http. This page includes an overview, setup tutorial, install commands, and use cases for Trae, Tongyi Lingma, Cursor, Claude Code, and VS Code.

Use cases

AgentHub Verified AvailabilityTested & Ready

Automated pipeline validated install commands, protocol & client compatibility

Verified At2026-10-04
Install Snippets TestedCLI & JSON config syntax verified
Protocol Handshake ReadyComplies with JSON-RPC 2.0 specifications
Origin Registry ActiveSourced from official-mcp-registry
Verified ClientsClaude Code、Claude Desktop、Cursor 等
Security Tier: A+ 级 · 官方认证推荐 (A+)·Maintained by official/verified teams, audited for standard MCP protocol compliance.

Copy by platform

Choose your platform

  1. Open or create .cursor/mcp.json in your project root
  2. Click Copy config and paste; merge only this mcpServers entry if others exist
  3. Replace <placeholders> in env with real secrets (see Environment variables below)
  4. Save, then Cmd+Shift+P → Reload Window

Pre-fill Environment Variables (Optional)

Required
Requiredsecret
Required
Requiredsecret
Required
Requiredsecret
Privacy Guarantee: Keys are replaced 100% locally in your browser memory and are NEVER uploaded or stored on any server.
Click to copy snippet
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Setup tutorial

  1. Open the NetBox MCP page and confirm this MCP Server (source: MCP Registry).
  2. Copy the Cursor, Claude Code, or VS Code snippet.
  3. Merge it into mcpServers and replace env placeholders with real secrets.
  4. Reload the window, then call the MCP tools from your agent chat.

Install commands

Install commands and setup steps are in the HTML so search engines and no-JS browsers can read them without running client JavaScript.

Claude Code (local)

  1. Install Claude Code CLI
  2. Copy the command below, replace <placeholders> with real env values, then run in terminal
  3. See Environment variables below if listed
claude mcp add netbox-mcp --env NETBOX_URL=<NETBOX_URL> --env NETBOX_TOKEN=<NETBOX_TOKEN> -- uvx netbox-mcp

Cursor — .cursor/mcp.json (local)

  1. Open or create .cursor/mcp.json in your project root
  2. Click Copy config and paste; merge only this mcpServers entry if others exist
  3. Replace <placeholders> in env with real secrets (see Environment variables below)
  4. Save, then Cmd+Shift+P → Reload Window
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

VS Code — .vscode/mcp.json (local)

  1. Install GitHub Copilot in VS Code with MCP support
  2. Open or create .vscode/mcp.json in your project root
  3. Click Copy config and paste; merge only this mcpServers entry if others exist
  4. Replace <placeholders> in env with real secrets
  5. Save and Developer: Reload Window
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Claude Desktop — claude_desktop_config.json (local)

  1. Open Claude Desktop claude_desktop_config.json (see remote guide for paths)
  2. Click Copy config and merge under mcpServers
  3. Replace <placeholders> in env with real secrets
  4. Fully quit and restart Claude Desktop
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Trae — .trae/mcp.json (local)

  1. Trae → Settings → MCP, or edit .trae/mcp.json / global mcp.json
  2. Click Copy config and merge mcpServers
  3. Replace <placeholders> in env with real secrets
  4. Save and reload Trae
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Cherry Studio — MCP settings (local)

  1. Cherry Studio → Settings → MCP Servers → Add (STDIO)
  2. Or import JSON: click Copy config and merge mcpServers
  3. Replace <placeholders> in env; ensure Node.js / uv (npx, uvx) are installed
  4. Enable the server and check tools load
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Tongyi Lingma — MCP config (local)

  1. Lingma Settings → MCP → + → STDIO or config file
  2. Click Copy config and merge mcpServers
  3. Replace <placeholders> in env; need Node.js 18+ (npx) or uv (uvx)
  4. Confirm connected before using tools in agent chat
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Windsurf — mcp_config.json (local)

  1. Edit ~/.codeium/windsurf/mcp_config.json
  2. Click Copy config and merge mcpServers (stdio same as Cursor)
  3. Replace <placeholders> in env, save, refresh Cascade
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Cline — MCP Servers (local)

  1. Cline panel → Settings → MCP Servers
  2. Click Copy config and merge
  3. Replace <placeholders> in env, then save
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

WorkBuddy — .workbuddy/mcp.json (local)

  1. Edit ~/.workbuddy/mcp.json (user) or project .workbuddy/mcp.json
  2. Or Plugins → MCP Servers → Configure MCP and paste the JSON below
  3. Replace <placeholders> in env; on Windows prefer absolute paths for command/scripts
  4. Save, restart WorkBuddy, confirm connector status is green
{
  "mcpServers": {
    "netbox-mcp": {
      "command": "uvx",
      "args": [
        "netbox-mcp"
      ],
      "env": {
        "NETBOX_URL": "<NETBOX_URL>",
        "NETBOX_TOKEN": "<NETBOX_TOKEN>"
      }
    }
  }
}

Troubleshooting & Common ErrorsFAQ

Common connection errors and verified fixes for NetBox MCP

Getting 'connection closed' or exit code 1 in Cursor / Claude Code for NetBox MCP?

Usually caused by missing runtime paths or IDE environment inheritance. Fix steps: 1. Verify Node.js 18+ (npx) or Python 3.10+ (uvx) is installed; 2. Run 'which npx' or 'which uvx' in terminal, and replace 'command' with absolute path; 3. Reload or restart the client window after modifying config.

Fix Snippet
# Check binary path in terminal:
which npx
node -v
Getting 'spawn npx ENOENT' or 'command not found'?

The editor background process does not inherit your full terminal PATH. Solution: Globally install the package, or set the absolute binary path (e.g. C:\Program Files\nodejs\npx.cmd on Windows, or /usr/local/bin/npx on macOS).

Missing required environment variable or authentication failure?

NetBox MCP requires environment variables (NETBOX_URL、NETBOX_TOKEN、NETBOX_URL、NETBOX_TOKEN、NETBOX_URL、NETBOX_TOKEN). Ensure you have added valid keys under the 'env' object in your config file without trailing whitespace.

Fix Snippet
// .cursor/mcp.json 或 claude_desktop_config.json
{
  "env": {
    "NETBOX_URL": "your_actual_key_here"
  }
}

Tool Mock Playground

Sandbox

NetBox MCP Tool Interface Simulation · Preview tool schema & outputs without local runtime

Sandbox Ready
fn: netbox_mcpExecute the core tool interface of NetBox MCP
Request ArgumentsJSON Schema
{
  "target": "NetBox MCP",
  "action": "execute",
  "options": {
    "mode": "standard",
    "timeoutMs": 5000
  }
}
💡Parameters generated dynamically by Agent runtime
Agent Tool Output

Click 'Run Mock' above

to preview the raw response returned to the LLM

Env: AgentHub Virtual SandboxJSON-RPC 2.0

Decision Guide: Why & When to Use

Assess suitability before installing to save trial-and-error time

Best Suited For
  • PR review
  • Changelog generation
  • Cross-repo issue search
When NOT to Use
  • Replacing human security audit
  • Unauthorized repo access
Recommended Workflow Pairing:View Scenario →

NetBox MCP + Scenario Prompt → Complete Agent Automation

MCP hands-on: install to visible results

Follow the full lab (expected UI/output + contrast checks). After installing this item, verify with the tutorial prompts.

Open tutorial →

Related resources

Often paired with

Keep exploring AgentHub

Most people compare similar tools or check scenario guides before installing—start here.

Listing badge: put AgentHub on your site

Copy either snippet into your project homepage, docs, or GitHub README. The badge is a hotlinked SVG — nothing to host — and it links back to this page so visitors can find the install steps.

PreviewListed on AgentHub: NetBox MCP
HTML
<a href="https://myagenthub.cn/p/io.github.mhajder/netbox-mcp" title="Listed on AgentHub: NetBox MCP" target="_blank" rel="noopener">
  <img src="https://myagenthub.cn/badge/io.github.mhajder/netbox-mcp?lang=en" alt="Listed on AgentHub: NetBox MCP" height="20" style="border:0"/>
</a>
Markdown (GitHub README)
[![Listed on AgentHub: NetBox MCP](https://myagenthub.cn/badge/io.github.mhajder/netbox-mcp?lang=en)](https://myagenthub.cn/p/io.github.mhajder/netbox-mcp)

Badges are generated on the fly from /badge/<package-id>, so name and listing changes propagate automatically. Keep the link target unchanged — it is what counts as the referral.

Unified Manifest

{
  "id": "io.github.mhajder/netbox-mcp",
  "type": "mcp-server",
  "version": "0.1.0",
  "displayName": "NetBox MCP",
  "description": "MCP server for NetBox DCIM/IPAM with read-only and dry-run modes",
  "repository": {
    "url": "https://github.com/mhajder/netbox-mcp",
    "source": "github"
  },
  "homepage": "https://github.com/mhajder/netbox-mcp",
  "distribution": {
    "packages": [
      {
        "registryType": "pypi",
        "identifier": "netbox-mcp",
        "version": "0.1.0",
        "runtimeHint": "uvx",
        "transport": "stdio",
        "environmentVariables": [
          {
            "name": "NETBOX_URL",
            "description": "NetBox base URL (e.g., https://netbox.example.com)",
            "isRequired": true
          },
          {
            "name": "NETBOX_TOKEN",
            "description": "NetBox API token: v2 (nbt_<key>.<token>, NetBox 4.5+) or legacy v1",
            "isRequired": true,
            "isSecret": true
          },
          {
            "name": "NETBOX_VERIFY_SSL",
            "description": "Verify SSL certificates (true/false)"
          },
          {
            "name": "NETBOX_TIMEOUT",
            "description": "Total time allowed for one NetBox request, retries included (seconds)"
          },
          {
            "name": "NETBOX_BRANCHING_ENABLED",
            "description": "Enable netbox-branching support: branch tools and the 'branch' argument (requires the netbox-branching plugin) (true/false)"
          },
          {
            "name": "NETBOX_BRANCH",
            "description": "Default netbox-branching branch (name or schema ID) for every call; requires NETBOX_BRANCHING_ENABLED=true"
          },
          {
            "name": "NETBOX_PLUGIN_DISCOVERY",
            "description": "Discover plugin object types from /api/core/object-types/ (true/false)"
          },
          {
            "name": "READ_ONLY_MODE",
            "description": "Hide all write tools (create, update, delete) (true/false)"
          },
          {
            "name": "DRY_RUN_MODE",
            "description": "Write tools only simulate changes and never modify NetBox (true/false)"
          },
          {
            "name": "DISABLED_TAGS",
            "description": "Comma-separated tool tags to disable (e.g. delete,graphql,branching)"
          },
          {
            "name": "LOG_LEVEL",
            "description": "Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)"
          },
          {
            "name": "RESPONSE_MAX_SIZE",
            "description": "Maximum tool response size in bytes (unset = unlimited)"
          },
          {
            "name": "RATE_LIMIT_ENABLED",
            "description": "Enable rate limiting"
          },
          {
            "name": "RATE_LIMIT_MAX_REQUESTS",
            "description": "Maximum requests per rate limit window"
          },
          {
            "name": "RATE_LIMIT_WINDOW_MINUTES",
            "description": "Rate limit window in minutes"
          },
          {
            "name": "TOOL_SEARCH_ENABLED",
            "description": "Enable FastMCP tool search transform"
          },
          {
            "name": "TOOL_SEARCH_STRATEGY",
            "description": "Tool search strategy (bm25 or regex)"
          },
          {
            "name": "TOOL_SEARCH_MAX_RESULTS",
            "description": "Maximum tool search results returned by search_tools"
          }
        ]
      },
      {
        "registryType": "pypi",
        "identifier": "netbox-mcp",
        "version": "0.1.0",
        "runtimeHint": "uvx",
        "transport": "streamable-http",
        "environmentVariables": [
          {
            "name": "NETBOX_URL",
            "description": "NetBox base URL (e.g., https://netbox.example.com)",
            "isRequired": true
          },
          {
            "name": "NETBOX_TOKEN",
            "description": "NetBox API token: v2 (nbt_<key>.<token>, NetBox 4.5+) or legacy v1",
            "isRequired": true,
            "isSecret": true
          },
          {
            "name": "NETBOX_VERIFY_SSL",
            "description": "Verify SSL certificates (true/false)"
          },
          {
            "name": "NETBOX_TIMEOUT",
            "description": "Total time allowed for one NetBox request, retries included (seconds)"
          },
          {
            "name": "NETBOX_BRANCHING_ENABLED",
            "description": "Enable netbox-branching support: branch tools and the 'branch' argument (requires the netbox-branching plugin) (true/false)"
          },
          {
            "name": "NETBOX_BRANCH",
            "description": "Default netbox-branching branch (name or schema ID) for every call; requires NETBOX_BRANCHING_ENABLED=true"
          },
          {
            "name": "NETBOX_PLUGIN_DISCOVERY",
            "description": "Discover plugin object types from /api/core/object-types/ (true/false)"
          },
          {
            "name": "READ_ONLY_MODE",
            "description": "Hide all write tools (create, update, delete) (true/false)"
          },
          {
            "name": "DRY_RUN_MODE",
            "description": "Write tools only simulate changes and never modify NetBox (true/false)"
          },
          {
            "name": "DISABLED_TAGS",
            "description": "Comma-separated tool tags to disable (e.g. delete,graphql,branching)"
          },
          {
            "name": "LOG_LEVEL",
            "description": "Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)"
          },
          {
            "name": "RESPONSE_MAX_SIZE",
            "description": "Maximum tool response size in bytes (unset = unlimited)"
          },
          {
            "name": "RATE_LIMIT_ENABLED",
            "description": "Enable rate limiting"
          },
          {
            "name": "RATE_LIMIT_MAX_REQUESTS",
            "description": "Maximum requests per rate limit window"
          },
          {
            "name": "RATE_LIMIT_WINDOW_MINUTES",
            "description": "Rate limit window in minutes"
          },
          {
            "name": "TOOL_SEARCH_ENABLED",
            "description": "Enable FastMCP tool search transform"
          },
          {
            "name": "TOOL_SEARCH_STRATEGY",
            "description": "Tool search strategy (bm25 or regex)"
          },
          {
            "name": "TOOL_SEARCH_MAX_RESULTS",
            "description": "Maximum tool search results returned by search_tools"
          },
          {
            "name": "MCP_HTTP_PORT",
            "description": "Port for HTTP server (default: 8000)"
          },
          {
            "name": "MCP_TRANSPORT",
            "description": "MCP transport type (http for HTTP, stdio for stdio)"
          }
        ]
      },
      {
        "registryType": "oci",
        "identifier": "ghcr.io/mhajder/netbox-mcp:0.1.0",
        "transport": "streamable-http",
        "environmentVariables": [
          {
            "name": "NETBOX_URL",
            "description": "NetBox base URL (e.g., https://netbox.example.com)",
            "isRequired": true
          },
          {
            "name": "NETBOX_TOKEN",
            "description": "NetBox API token: v2 (nbt_<key>.<token>, NetBox 4.5+) or legacy v1",
            "isRequired": true,
            "isSecret": true
          },
          {
            "name": "NETBOX_VERIFY_SSL",
            "description": "Verify SSL certificates (true/false)"
          },
          {
            "name": "NETBOX_TIMEOUT",
            "description": "Total time allowed for one NetBox request, retries included (seconds)"
          },
          {
            "name": "NETBOX_BRANCHING_ENABLED",
            "description": "Enable netbox-branching support: branch tools and the 'branch' argument (requires the netbox-branching plugin) (true/false)"
          },
          {
            "name": "NETBOX_BRANCH",
            "description": "Default netbox-branching branch (name or schema ID) for every call; requires NETBOX_BRANCHING_ENABLED=true"
          },
          {
            "name": "NETBOX_PLUGIN_DISCOVERY",
            "description": "Discover plugin object types from /api/core/object-types/ (true/false)"
          },
          {
            "name": "READ_ONLY_MODE",
            "description": "Hide all write tools (create, update, delete) (true/false)"
          },
          {
            "name": "DRY_RUN_MODE",
            "description": "Write tools only simulate changes and never modify NetBox (true/false)"
          },
          {
            "name": "DISABLED_TAGS",
            "description": "Comma-separated tool tags to disable (e.g. delete,graphql,branching)"
          },
          {
            "name": "LOG_LEVEL",
            "description": "Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)"
          },
          {
            "name": "RESPONSE_MAX_SIZE",
            "description": "Maximum tool response size in bytes (unset = unlimited)"
          },
          {
            "name": "RATE_LIMIT_ENABLED",
            "description": "Enable rate limiting"
          },
          {
            "name": "RATE_LIMIT_MAX_REQUESTS",
            "description": "Maximum requests per rate limit window"
          },
          {
            "name": "RATE_LIMIT_WINDOW_MINUTES",
            "description": "Rate limit window in minutes"
          },
          {
            "name": "TOOL_SEARCH_ENABLED",
            "description": "Enable FastMCP tool search transform"
          },
          {
            "name": "TOOL_SEARCH_STRATEGY",
            "description": "Tool search strategy (bm25 or regex)"
          },
          {
            "name": "TOOL_SEARCH_MAX_RESULTS",
            "description": "Maximum tool search results returned by search_tools"
          },
          {
            "name": "MCP_HTTP_PORT",
            "description": "Port for HTTP server (default: 8000)"
          }
        ]
      }
    ],
    "remotes": []
  },
  "dependencies": [],
  "installTargets": [
    "claude-code",
    "claude-desktop",
    "cursor",
    "vscode",
    "trae",
    "cherry-studio",
    "lingma",
    "windsurf",
    "cline",
    "workbuddy"
  ],
  "keywords": [],
  "provenance": {
    "origin": "official-mcp-registry",
    "originalId": "io.github.mhajder/netbox-mcp",
    "originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.mhajder%2Fnetbox-mcp/versions/latest",
    "isOfficial": true,
    "status": "active"
  }
}
NetBox MCP Setup & Guide - AgentHub