netbox-best-practices AGENTS.md

netbox-best-practices AGENTS.md is an instructions file for Codex, OpenCode from netboxlabs/netbox-best-practices. It costs 779 tokens per session, scanned A, original, Apache-2.0.

Development instructions for integrating with NetBox, a system that manages network and infrastructure inventory through an API. They cover authentication, pagination, performance, ingestion, and where guidance is stored for different coding assistants.

In plain words
What is it for?
Use them when building NetBox API integrations, choosing Python libraries or ingestion methods, handling tokens, paginating requests, and locating the relevant rules.
Why use it?
They help prevent common integration errors such as missing results from unpaginated requests or using outdated authentication methods.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/netboxlabs/netbox-best-practices/agents-md
Clone the repo
git clone --depth 1 https://github.com/netboxlabs/netbox-best-practices

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for netbox-best-practices AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/netboxlabs/netbox-best-practices/agents-md.svg)](https://agentmods.dev/instructions/netboxlabs/netbox-best-practices/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/netboxlabs/netbox-best-practices/agents-md"><img src="https://agentmods.dev/badge/instructions/netboxlabs/netbox-best-practices/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 779 This file is loaded in full into every session.
When invoked 779 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00779 $0.00779
Opus 5 $0.00390 $0.00390
Sonnet 5 $0.00156 $0.00156
Haiku 4.5 $0.00078 $0.00078

Measured 5d ago against content hash 56fdab3e29ea, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

netbox-best-practices AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 81 lines

How it starts

The opening of the file, as written. The whole thing — 81 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md - NetBox Best Practices

This repository contains best practices for NetBox API integrations. The content is available in multiple formats for different AI coding assistants and human readers.

Quick Start

When working on NetBox integrations, follow these key principles:

  1. Use v2 tokens on NetBox 4.5+ (Bearer nbt_<key>.<token>)
  2. Always paginate list requests - NetBox defaults to 50 items
  3. Use brief mode (?brief=True) and exclude config_context for performance
  4. Use Diode for high-volume data ingestion (handles dependencies automatically)
  5. Use pynetbox for Python integrations

Content Locations

Format Location Audience
Human Documentation HUMAN.md Engineers/developers
Claude Code Skills skills/*/SKILL.md Claude Code users
Cursor Rules .cursor/rules/*.mdc Cursor IDE users
Detailed Rules skills/*/references/rules/*.md All (authoritative source)

Available Rules by Category

Authentication (auth-)

  • Use v2 tokens on NetBox 4.5+ (CRITICAL)
  • Use provisioning endpoint for automated token creation

REST API (rest-)

  • Always paginate list requests (HIGH)
  • Use bulk operations via list endpoints (CRITICAL)
  • Use PATCH for partial updates, not PUT
  • Use brief mode and field selection for performance
  • Avoid ?q= search filter at scale

GraphQL (graphql-)

  • Use netbox-graphql-query-optimizer (CRITICAL)
  • Always paginate, including nested lists (CRITICAL)
  • Keep query depth ≤3
  • Select only needed fields

Performance (perf-)

  • Exclude config_context from device queries
  • Use brief mode for large list operations

Data Modeling (data-)

  • Create objects in dependency order (CRITICAL)
  • Understand site/location hierarchy
  • Use natural keys for queries
  • Properly structure custom fields and tags

Integration (integ-)

  • Use Diode for high-volume ingestion (HIGH)
  • Use pynetbox for Python integrations (HIGH)
  • Use branching plugin for change management workflows (HIGH) - requires netbox-branching
  • Configure webhooks for change notifications
  • Query object changes for audit trails

Read the full file on GitHub · 81 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 5d ago First seen · 81 lines · 779 tokens per session scan A 56fdab3e29ea

Subscribe to this mod's changes

netbox-best-practices AGENTS.md is an instructions file published in the GitHub repository netboxlabs/netbox-best-practices (29 stars, last pushed 7mo ago), licensed Apache-2.0. It adds 779 tokens to every session, about $0.0039 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens