MCP Netbox 31bea54d

MCP文档知识

提供方 DD879

文档知识 stdio · 本地进程 Token 社区 / 第三方 Claude DesktopClaude
查看接入方式

一个全面的读/写模型上下文协议服务器,用于NetBox网络文档和IPAM系统,支持通过自然语言与NetBox基础设施交互。

一句话选型结论

按资料字段整理

MCP Netbox 31bea54d 属于文档知识类 MCP 服务器,stdio · 本地进程,Token,可直接接入 Claude Desktop、Claude,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权Token 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 103 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量103暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

网络文档Python本地部署IPAM系统自然语言交互基础设施管理企业级安全

安装与配置

stdio · 本地进程 Token
客户端在本机拉起子进程,数据不出本机
docker run -d \

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Docker,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 103 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 103 个工具,覆盖面较广,能满足多种调用。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
MCP Netbox 31bea54d当前 103 stdio · 本地进程 本地部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方DD879上游标注的维护方 DD879
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Docker本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

15.1 KB
来自项目仓库与上游目录的原文,未做删改

NetBox MCP Server

A comprehensive read/write Model Context Protocol server for NetBox network documentation and IPAM systems. Just as our LEGO parrot mascot symbolically mimics human speech, this server allows you to "talk" to your NetBox infrastructure using natural language through LLMs that support MCP.

✨ Key Features

  • 142+ MCP Tools: Complete DCIM, IPAM, tenancy, extras, system, and virtualization management with dual-tool pattern architecture
  • 🦜 Bridget - Your NetBox Infrastructure Guide
  • Auto-Context Detection - Intelligent environment detection (demo/staging/production)
  • Safety Guidance - Context-aware operational recommendations
  • Persona-Based Assistance - Friendly, professional infrastructure guidance
  • Enterprise Safety - Automatic safety level assignment based on environment
  • 🔐 Safety First: Built-in dry-run mode, confirmation requirements, and audit logging
  • 🏗️ Self-Describing: Automatic tool discovery with REST API endpoints
  • ⚡ Enterprise Hardening: Production-ready secrets management and structured logging
  • 📊 Performance Optimized: TTL-based caching with 33%+ performance improvements
  • 🔄 Write Operations: Full read/write capabilities with idempotent operations
  • 🐳 Docker Ready: Enterprise-grade containerization with health checks

🚀 Quick Start

Docker (Recommended)```bash

docker run -d \
--name netbox-mcp \
-e NETBOX_URL="https://your-netbox.example.com" \
-e NETBOX_TOKEN="your-api-token" \
-e NETBOX_MCP_TRANSPORT="streamable-http" \
-e NETBOX_MCP_HOST="0.0.0.0" \
-e NETBOX_MCP_PORT="8000" \
-p 8000:8000 \
-p 8080:8080 \
controlaltautomate/netbox-mcp:latest


**MCP endpoint**: `http://localhost:8000/mcp`
**Health endpoints**: `http://localhost:8080/healthz` (liveness), `http://localhost:8080/readyz` (readiness)

### Connect via Streamable HTTP (MCP over HTTP)

This server supports both **stdio** (default) and **Streamable HTTP** transports.

- **stdio**: ideal for Claude Desktop (the client launches the server as a subprocess)
- **Streamable HTTP**: ideal for Docker / remote deployments (the server listens on an HTTP port)

Example (Claude Code CLI):```bash
# Add the server as an HTTP MCP endpoint
claude mcp add --transport http netbox http://localhost:8000/mcp

> Tip: If you run the container, keep NETBOX_MCP_HOST=0.0.0.0 so the MCP endpoint is reachable outside the container.

Python Installation```bash

git clone https://github.com/Deployment-Team/netbox-mcp.git
cd netbox-mcp
pip install .


### Bridget Auto-Context Experience

For the optimal Bridget experience with full auto-context and persona guidance:
- **Recommended**: Use Claude Code CLI for complete functionality
- **Alternative**: Claude Desktop (tools work, limited prompt support)

See the Bridget Documentation in our wiki for complete usage guide.

## 📊 Current Status

**Version**: 1.1.2 - Documentation & Version Sync! ⭐

**🎉 NEW: MANAGEMENT IP SUITE**: Complete out-of-band and primary IP management tools for enterprise device automation:
- `netbox_create_interface` with `mgmt_only` parameter for BMC/iDRAC/Console interfaces
- Enhanced `netbox_update_device` with `oob_ip`, `primary_ip4`, `primary_ip6` support
- `netbox_set_primary_ip` with flexible IP resolution and device validation

**✅ PRODUCTION READY**: All management IP workflows tested against NetBox 4.3.2 with comprehensive bug fixes and enterprise safety features.

**🔧 COMPREHENSIVE COVERAGE**: 142+ production-ready tools across six domains:
- **DCIM Tools (73)**: Complete device and infrastructure lifecycle management with power management and management IP support
- **Virtualization Tools (30)**: Complete VM infrastructure management (NEW) ⭐
- **IPAM Tools (16)**: IP address and network management with enterprise automation
- **Tenancy Tools (8)**: Multi-tenant resource management with hierarchical organization
- **Extras Tools (2)**: Journal entries and audit trail management
- **System Tools (1)**: Health monitoring and system status

**🚀 DISCOVERY TOOLS**: 23+ `list_all_*` tools enabling efficient bulk exploration:
- `netbox_list_all_devices`, `netbox_list_all_sites`, `netbox_list_all_racks`, `netbox_list_all_power_panels`, `netbox_list_all_power_feeds`, `netbox_list_all_power_outlets`, `netbox_list_all_power_cables`, `netbox_list_all_module_type_profiles` (DCIM)
- `netbox_list_all_prefixes`, `netbox_list_all_vlans`, `netbox_list_all_vrfs` (IPAM)
- `netbox_list_all_tenants`, `netbox_list_all_tenant_groups` (Tenancy)
- `netbox_list_all_manufacturers`, `netbox_list_all_device_types`, `netbox_list_all_device_roles` (Device Management)

**🛡️ ENTERPRISE FOUNDATION**: Defensive Read-Validate-Write Pattern with Registry Bridge ensuring 100% tool accessibility and conflict detection accuracy.

## ⚙️ Configuration

**Quick Setup**: Set required environment variables:

- `NETBOX_URL`: Full URL to your NetBox instance
- `NETBOX_TOKEN`: API token from NetBox

**MCP Transport Settings** (optional):

- `NETBOX_MCP_TRANSPORT`: `stdio` (default) or `streamable-http`
- `NETBOX_MCP_HOST`: bind address for HTTP transport (default: `127.0.0.1`)
- `NETBOX_MCP_PORT`: bind port for HTTP transport (default: `8000`)
- `NETBOX_MCP_PATH`: MCP path (default: `/mcp`)
- `NETBOX_MCP_STATELESS_HTTP`: `true/false` (default: `false`)
- `NETBOX_MCP_JSON_RESPONSE`: `true/false` (default: `false`)

### 🎯 Tool Profiles (for Ollama & smaller LLMs)

The server supports **dynamic tool profiles** to optimize context usage for smaller models like Ollama's qwen2.5:7b. Instead of overwhelming the model with 142+ tools, you can start with a focused subset.

**Available Profiles**:

| Profile | Tools | Description |
|---------|-------|-------------|
| `minimal` | ~5 | Only profile management meta-tools |
| `essential` | ~25 | Basic operations: list, get, search (**default**) |
| `ipam` | ~35 | IP management: IPs, prefixes, VLANs, VRFs |
| `dcim` | ~50 | Infrastructure: devices, racks, cables |
| `readonly` | ~70 | All read operations (safe exploration) |
| `write` | ~60 | Write operations: create, update, delete |
| `full` | 142+ | All tools (requires large models 14B+) |

**Configuration**:```bash
# Via environment variable
NETBOX_TOOL_PROFILE=ipam

# Via netbox-mcp.yaml
tool_profile: "ipam"
enable_tool_profiles: true

Dynamic Profile Switching:

The AI model can switch profiles during conversation:```
User: "I need to manage IP addresses"
Model: → netbox_profile_activate(profile="ipam")
✅ IPAM tools now available

User: "List IPs in 10.0.0.0/24"
Model: → netbox_list_ip_addresses(prefix="10.0.0.0/24")


**Profile Meta-Tools** (always available):
- `netbox_profile_list` - List available profiles
- `netbox_profile_activate` - Switch to a profile
- `netbox_profile_current` - Show active profile and tools
- `netbox_tool_search` - Search for tools by name/description
- `netbox_tool_help` - Usage guide

**Advanced Configuration**: Use YAML/TOML configuration files or additional environment variables for enterprise features like secrets management and structured logging.

## 🔒 Safety & Enterprise Features

**CRITICAL SAFETY CONTROLS**: This MCP server can perform write operations on NetBox data:

- ✅ **Idempotent Operations**: All write tools are idempotent by design
- ✅ **Confirmation Required**: `confirm=True` parameter for all write operations
- ✅ **Global Dry-Run Mode**: `NETBOX_DRY_RUN=true` for testing
- ✅ **Audit Logging**: Comprehensive logging of all operations
- ✅ **Transaction Safety**: Atomic operations with rollback capabilities

## 🏗️ Architecture Highlights

### Revolutionary Dual-Tool Pattern
- **Fundamental LLM Architecture**: Every NetBox domain implements both "info" tools (detailed single-object retrieval) and "list_all" tools (bulk discovery/exploration)
- **Comprehensive Filtering**: All list tools support filtering by site, tenant, status, and domain-specific criteria
- **Summary Statistics**: Rich aggregate statistics, breakdowns, and utilization metrics for operational insight
- **Cross-Domain Integration**: Tools bridge DCIM, IPAM, and Tenancy domains with relationship tracking

### Revolutionary Self-Describing Server
- **@mcp_tool Decorator**: Automatic function inspection and metadata generation
- **Plugin Architecture**: Modular tools/ subpackage with automatic discovery
- **Registry Bridge Pattern**: Seamless connection between internal registry and FastMCP interface
- **Dependency Injection**: Clean separation using FastAPI's Depends() system
- **REST API Endpoints**: `/api/v1/tools`, `/api/v1/execute`, `/api/v1/status`

#### Bridget Auto-Context Layer```
Auto-Context Detection → Environment Assessment → Safety Assignment → Persona Guidance

Enterprise Security & Operations

  • Secrets Management: Docker secrets, Kubernetes secrets, environment variables
  • Structured Logging: JSON logging compatible with ELK Stack, Splunk, Datadog
  • Performance Monitoring: Correlation IDs, operation timing, cache statistics

📚 Documentation

  • Complete Wiki - Comprehensive documentation with examples
  • API Reference - Complete tool documentation
  • Installation Guide - Setup and deployment
  • Docker Guide - Container deployment
  • Enterprise Showcase - Real-world use cases

📋 Requirements

  • Python 3.10+
  • NetBox 3.5+ or newer (REST API v2.8+ support)
  • Valid NetBox API token with appropriate permissions

🚀 Available Tools

System Tools (1):
- netbox_health_check - Comprehensive health check

IPAM Tools (12):
- netbox_create_ip_address - Create IP address assignments
- netbox_find_available_ip - Find available IPs in network
- netbox_get_ip_usage - Network utilization statistics
- netbox_create_prefix - Create network prefixes
- netbox_create_vlan - Create VLANs
- netbox_find_available_vlan_id - Find available VLAN IDs
- netbox_create_vrf - Create VRF instances
- netbox_assign_mac_to_interface - 🆕 Enterprise MAC address management with defensive conflict detection
- netbox_find_next_available_ip - 🆕 Atomic IP reservation with cross-domain integration
- netbox_get_prefix_utilization - 🆕 Comprehensive capacity planning reports
- netbox_provision_vlan_with_prefix - 🆕 Atomic VLAN/prefix coordination
- netbox_assign_ip_to_interface - 🆕 Cross-domain IPAM/DCIM integration

DCIM Tools (73):
- Core Infrastructure (17 tools):
- netbox_create_site, netbox_get_site_info - Site management
- netbox_create_rack, netbox_get_rack_elevation - Rack management
- netbox_create_manufacturer - Manufacturer management
- netbox_create_device_type, netbox_get_device_type_info, netbox_update_device_type, netbox_delete_device_type - 🆕 Complete device type CRUD
- netbox_create_device_role - Device role management
- netbox_create_device, netbox_get_device_info, netbox_update_device - 🆕 Enhanced device management with management IP support
- netbox_install_module_in_device - Device component installation
- netbox_add_power_port_to_device - Power infrastructure documentation

  • Management & OOB IP Suite (3 tools) 🆕:
  • netbox_create_interface - 🆕 Interface creation with mgmt_only support for BMC/iDRAC
  • netbox_set_primary_ip - 🆕 Primary IP assignment with intelligent resolution
  • Enhanced netbox_update_device with oob_ip, primary_ip4, primary_ip6 parameters

  • Module Type Profiles (6 tools) 🆕 NetBox 4.3.x:

  • netbox_create_module_type_profile, netbox_get_module_type_profile_info, netbox_list_all_module_type_profiles
  • netbox_update_module_type_profile, netbox_delete_module_type_profile, netbox_assign_module_type_profile

  • Module Management (2 enhanced tools) 🆕:

  • netbox_update_module_type, netbox_delete_module_type - Complete module type CRUD

  • Power Management Infrastructure (19 tools) 🆕:

  • Power Panels (5): netbox_create_power_panel, netbox_get_power_panel_info, netbox_list_all_power_panels, netbox_update_power_panel, netbox_delete_power_panel
  • Power Feeds (5): netbox_create_power_feed, netbox_get_power_feed_info, netbox_list_all_power_feeds, netbox_update_power_feed, netbox_delete_power_feed
  • Power Outlets (5): netbox_create_power_outlet, netbox_get_power_outlet_info, netbox_list_all_power_outlets, netbox_update_power_outlet, netbox_delete_power_outlet
  • Power Connections (4): netbox_create_power_cable, netbox_get_power_connection_info, netbox_list_all_power_cables, netbox_disconnect_power_cable

  • Inventory Management Suite (7 tools):

  • netbox_add_inventory_item_template_to_device_type, netbox_list_inventory_item_templates_for_device_type
  • netbox_add_inventory_item_to_device, netbox_list_device_inventory, netbox_update_inventory_item
  • netbox_remove_inventory_item, netbox_bulk_add_standard_inventory

Tenancy Tools (8):
- netbox_create_contact_for_tenant - 🆕 Contact management with role-based assignment
- netbox_onboard_new_tenant - Complete tenant onboarding with contact integration
- netbox_create_tenant_group - Hierarchical tenant organization
- netbox_assign_resources_to_tenant - Cross-domain resource assignment
- netbox_get_tenant_resource_report - Comprehensive tenant resource reporting
- netbox_list_all_tenants - Bulk tenant discovery
- netbox_list_all_tenant_groups - Tenant group exploration

Extras Tools (2):
- netbox_create_journal_entry - 🆕 Create audit trail entries for any NetBox object
- netbox_list_all_journal_entries - 🆕 Bulk journal entry discovery with filtering

Virtualization Tools (30) ⭐ NEW:
- Clusters (5 tools): netbox_create_cluster, netbox_get_cluster_info, netbox_list_all_clusters, netbox_update_cluster, netbox_delete_cluster
- Virtual Machines (5 tools): netbox_create_virtual_machine, netbox_get_virtual_machine_info, netbox_list_all_virtual_machines, netbox_update_virtual_machine, netbox_delete_virtual_machine
- Cluster Types (5 tools): netbox_create_cluster_type, netbox_get_cluster_type_info, netbox_list_all_cluster_types, netbox_update_cluster_type, netbox_delete_cluster_type
- Cluster Groups (5 tools): netbox_create_cluster_group, netbox_get_cluster_group_info, netbox_list_all_cluster_groups, netbox_update_cluster_group, netbox_delete_cluster_group
- VM Interfaces (5 tools): netbox_create_vm_interface, netbox_get_vm_interface_info, netbox_list_all_vm_interfaces, netbox_update_vm_interface, netbox_delete_vm_interface
- Virtual Disks (5 tools): netbox_create_virtual_disk, netbox_get_virtual_disk_info, netbox_list_all_virtual_disks, netbox_update_virtual_disk, netbox_delete_virtual_disk

🤝 Contributing

This project is under active development. See our GitHub Issues for:

  • Current development priorities
  • Feature requests and roadmap
  • Bug reports and discussions

📄 License

MIT License - see LICENSE file for details.

🔗 Related Projects

  • Enterprise network automation tools - Production-ready MCP servers
  • NetBox - The network documentation and IPAM application

⚠️ Development Notice: This is a development version with write capabilities. Always use proper safety measures and test in non-production environments.

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
MCP Netbox 31bea54d 怎么安装?

在客户端按下面的安装命令接入:docker run -d \。装完在客户端配置里引用同一个包或端点。

MCP Netbox 31bea54d 怎么在 Claude Desktop、Claude 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

MCP Netbox 31bea54d 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

MCP Netbox 31bea54d 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

MCP Netbox 31bea54d 支持哪些客户端?

资料标注支持 Claude Desktop、Claude;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

MCP Netbox 31bea54d 能提供哪些能力?

资料显示约 103 个工具;能力标签包括 基础设施管理、Python、Claude。具体工具清单以官方文档为准。

MCP Netbox 31bea54d 需要什么运行环境?

运行时为 Docker;属于本地进程,需要在本机装好运行环境。

MCP Netbox 31bea54d 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。