AN

alexkiwi1/netbox-mcp-rw

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

18 stars 10 forks 质量 65 趋势 22Apache-2.0

与现有的只读 NetBox MCP 执行不同,此服务器提供了全面的 CRUD(创建,读取,更新,删除) 操作,使您不仅能够查询您的NetBox 数据,而且能够查询...

概览

与现有的只读 NetBox MCP 执行不同,这个服务器提供了全面的 CRUD(创建,读取,更新,删除) 操作,使您不仅可以查询您的NetBox数据,还可以通过支持MCP的LLMs直接修改. -:唯一允许从NetBox读取和写入的MCP服务器 - :创建,读取,更新并删除任何NetBox对象类型 - :一次高效地处理多个对象 - :支持所有主要的NetBox模型(DCIM,IPAM,电路,虚拟等).

概述(AI 翻译)

** 第一个具有NetBox全读和写能力的模型上下文协议服务器。 **

与现有的只读 NetBox MCP 执行不同,这个服务器提供了全面的 CRUD(创建,读取,更新,删除) 操作,使您不仅可以查询您的NetBox数据,还可以通过支持MCP的LLMs直接修改.

□是什么使这个特殊

  • ** 第一读-写 NetBox MCP**: 唯一允许从 NetBox 读取和写入的 MCP 服务器
  • ** 全部 CRUD 操作**: 创建、读取、更新和删除任何 NetBox 对象类型
  • ** bulk 操作**: 一次高效处理多个对象
  • 全面覆盖:支持所有主要的NetBox模型(DCIM、IPAM、电路、虚拟化等)
  • ** 准备就绪**:建造有适当的错误处理、验证和安全做法

□ 特性

QQ 读取操作

  • 列出和过滤任何 NetBox 对象类型
  • 获得关于特定物体的详细资料
  • 查阅更改历史和审计线索
  • 高级过滤和搜索能力

QQ 写操作

  • 创建新的设备、IP地址、网站、架子和更多
  • 更新现有对象属性

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

NetBox MCP Server - Read & Write Edition

The first Model Context Protocol (MCP) server with full read AND write capabilities for NetBox.

Unlike existing read-only NetBox MCP implementations, this server provides comprehensive CRUD (Create, Read, Update, Delete) operations, enabling you to not only query your NetBox data but also modify it directly through LLMs that support MCP.

What Makes This Special

  • First Read-Write NetBox MCP: The only MCP server that allows both reading from AND writing to NetBox
  • Full CRUD Operations: Create, read, update, and delete any NetBox object type
  • Bulk Operations: Efficiently handle multiple objects at once
  • Comprehensive Coverage: Supports all major NetBox models (DCIM, IPAM, Circuits, Virtualization, etc.)
  • Production Ready: Built with proper error handling, validation, and security practices

Features

Read Operations

  • List and filter any NetBox object type
  • Get detailed information about specific objects
  • Access change history and audit trails
  • Advanced filtering and search capabilities

Write Operations

  • Create new devices, IP addresses, sites, racks, and more
  • Update existing object properties
  • Delete objects (with proper safeguards)
  • Bulk create, update, and delete operations

Supported Object Types

DCIM (Device and Infrastructure):

  • devices, device-types, device-roles, manufacturers
  • sites, locations, racks, rack-roles
  • cables, interfaces, power-ports, console-ports
  • platforms, regions, virtual-chassis

IPAM (IP Address Management):

  • ip-addresses, prefixes, vlans, vrfs
  • asns, aggregates, services
  • roles, rirs, route-targets

Circuits:

  • circuits, circuit-types, providers
  • circuit-terminations, provider-networks

Virtualization:

  • virtual-machines, clusters, cluster-groups
  • cluster-types, vm-interfaces

And many more…

Installation

  1. Clone this repository:
git clone https://github.com/alexkiwi1/netbox-mcp-rw.git
cd netbox-mcp-rw
  1. Install dependencies:
# Using UV (recommended)
uv sync

# Or using pip
pip install -e .
  1. Set environment variables:
export NETBOX_URL="https://your-netbox-instance.com/"
export NETBOX_TOKEN="your-api-token"
  1. Test the server:
NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN= uv run server.py

MCP Client Configuration

Claude Desktop (Mac/Windows)

Add to your Claude Desktop configuration:

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

Other MCP Clients

This server works with any MCP-compatible client. Adjust the command and arguments based on your client’s requirements.

Usage Examples

Reading Data

在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手?先看 mcpskill.org 教程 →

配置

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