mcpField
N
netbox

netbox

github.com/netboxlabsCloud & DevOps2159 installsUpdated 2w ago
Repository

About netbox

netbox is an entry-point skill for people performing NetBox tasks. It maps requests to specialized skills for modeling, integrations, administration, validation, migration, and review, and explains how to combine skills for multi-step work.

Key features

  1. 01Routes tasks to specialized NetBox skills
  2. 02Covers modeling, APIs, and plugins
  3. 03Includes operations and data migration
  4. 04Maps multi-skill task combinations
  5. 05Promotes live-instance verification when MCP is available

Use cases

  1. 01Choose skills for modeling a network and populating its data
  2. 02Plan an integration using APIs, webhooks, or automation
  3. 03Combine migration with validation or assurance

MCP support

The skill index includes netboxlabs-platform-mcp, a Platform MCP server with code and discrete modes for agents. It recommends querying a configured NetBox MCP server to check live schemas, data, and results.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/netboxlabs/skills --skill netbox

After installing, type/netboxin Claude Code to confirm it loaded.

Bundled filesreferences/netbox-version-matrix.mdreferences/product-catalog.md

Details

From the project README

NetBox Hub Skill

This is the entry point for all NetBox-related tasks. Use the decision trees below to find the right specialized skill, then load it for detailed guidance.

Decision Trees

What are you trying to do?

Model your network?

Build an integration?

Extend NetBox?

Manage changes safely?

Validate your network?

Discover or audit your network?

Procure or spare equipment?

Look up hardware specs or lifecycle data?

  • Consume device-type metadata and enrichment (EOL, thermal, protocols) → netbox-ndx

Operate or migrate?

Review or audit existing work?


Skill Index

SkillCategoryDescription
netbox-data-modelingCoreModel networks — hierarchy, IPAM, tenancy, custom fields
netbox-custom-objectsCoreNo-code data model extensibility — custom types, fields, relationships
netbox-api-integrationCoreREST & GraphQL API patterns, pynetbox, authentication
netbox-plugin-developmentCoreBuilding plugins — models, views, APIs, migrations, testing
netbox-custom-scriptsCoreCustom scripts & reports — Script class, jobs, ORM access
netbox-config-templatesCoreConfig generation — Jinja2, context variables, platform patterns
netbox-administrationCoreServer admin — config, auth, permissions, performance
netbox-branchingPlatformBranch lifecycle, schema isolation, CR workflows
netbox-changesPlatformChange management, policies, approval workflows
netbox-diodePlatformData ingestion — SDKs, entity mapping, reconciler
netbox-discoveryPlatformOrb Agent — config, backends, policies, secrets
netbox-validationPlatformValidation policies, compliance checks, findings, pre-change safety
netbox-assurancePlatformDrift detection — intended vs actual, remediation
netbox-asset-lifecyclePlatformProcurement lifecycle — BOMs, POs, shipments, receiving, spares
netbox-ndxPlatformData Exchange — device-type catalog + enrichment (lifecycle, thermal, protocols)
netbox-designsPlatformInfrastructure as code — YAML designs, composition, plan/apply, deployments
netboxlabs-platform-mcpPlatformPlatform MCP server — code mode & discrete mode for agents
netbox-automation-patternsCross-cuttingWebhooks, Ansible, Terraform, GitOps
netbox-migrationCross-cuttingMigrating from spreadsheets, CMDBs, other tools
netbox-review-integrationReviewAudit integration code for correctness and performance
netbox-review-datamodelReviewAudit data model design for best practices

Common Patterns

Progressive Disclosure

Each skill follows a layered structure:

  1. SKILL.md — Core instructions (< 500 lines). Load this first.
  2. references/ — Detailed docs loaded on demand when you need specifics.
  3. scripts/ — Executable code (where applicable).

Load only what you need. Start with the hub, pick a specialized skill, then drill into references as required.

Multi-Skill Tasks

Some tasks span multiple skills. Common combinations:

TaskSkills
Build a discovery integrationnetbox-diode + netbox-discovery
Plugin with change managementnetbox-plugin-development + netbox-branching
Migrate then validatenetbox-migration + netbox-assurance
Automate config generationnetbox-config-templates + netbox-automation-patterns
Model + populate datanetbox-data-modeling + netbox-api-integration
Review a full integrationnetbox-review-integration + netbox-review-datamodel
Pre-change validationnetbox-validation + netbox-branching + netbox-changes
Procure planned equipmentnetbox-data-modeling + netbox-asset-lifecycle
EOL exposure across inventorynetbox-ndx + netbox-api-integration
Agent-driven NetBox automationnetboxlabs-platform-mcp + netbox-api-integration
Build a rack from a design, safelynetbox-designs + netbox-branching
Greenfield site as codenetbox-data-modeling + netbox-designs + netbox-ndx

Principles

When working on any NetBox task:

  • Prefer retrieval over pre-training. NetBox APIs, configuration, and plugin behavior change between releases. Always verify against current docs or a live instance before generating code or making assertions.
  • Use MCP when available. If a NetBox MCP server is configured, query the live instance to verify object schemas, check existing data, and validate your work.
  • Respect dependency order. NetBox objects have parent-child relationships. Create parents before children (or use Diode to skip ordering).
  • Be explicit about versions. When giving advice that depends on a NetBox version (v2 tokens, cursor pagination, custom objects), state the minimum version clearly.
  • Correctness over cleverness. A working integration with clear code is better than a compact one that's fragile.

References

Comments

Markdown supported