netbox-performance

Des règles pour accélérer les appels à l’API NetBox, un service qui gère un inventaire d’équipements et de ressources réseau. Elles recommandent des réponses courtes et des filtres ciblés.

In plain words
What is it for?
Elles servent à exclure les calculs inutiles, utiliser le mode bref, sélectionner des champs et remplacer la recherche générale par des filtres précis.
Why use it?
Elles réduisent la quantité de données renvoyées et évitent des recherches coûteuses lorsque l’inventaire est volumineux.

Cursor rule for Cursor

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 rules/netboxlabs/netbox-best-practices/netbox-performance
Clone the repo
git clone --depth 1 https://github.com/netboxlabs/netbox-best-practices

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 431 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00000 $0.00431
Opus 5 $0.00000 $0.00216
Sonnet 5 $0.00000 $0.00086
Haiku 4.5 $0.00000 $0.00043

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

Security

Grade A, and why

netbox-performance scanned grade A with 1 finding 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 3d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

response = requests.get(f"{API_URL}/dcim/devices/")
.cursor/rules/netbox-performance.mdc · 68 lines

What it actually says

NetBox Performance Best Practices

Exclude config_context (HIGH)

Config context computation is expensive. Always exclude when not needed.

# Slow - includes computed config_context
response = requests.get(f"{API_URL}/dcim/devices/")

# Fast - excludes config_context
response = requests.get(
    f"{API_URL}/dcim/devices/",
    params={"exclude": "config_context"}
)

Use Brief Mode for Lists (HIGH)

Brief mode returns minimal nested object data.

# Full response (~2KB per device)
response = requests.get(f"{API_URL}/dcim/devices/")

# Brief response (~500 bytes per device)
response = requests.get(f"{API_URL}/dcim/devices/?brief=True")

Combine with field selection for maximum efficiency:

params = {
    "brief": "True",
    "exclude": "config_context",
    "fields": "id,name,status,site"
}

Avoid ?q= Search Filter at Scale (HIGH)

The generic ?q= search filter searches across multiple fields and is expensive at scale.

# WRONG: Generic search across all fields
response = requests.get(f"{API_URL}/dcim/devices/?q=nyc")

# CORRECT: Specific field filters
response = requests.get(f"{API_URL}/dcim/devices/?name__ic=nyc")
response = requests.get(f"{API_URL}/dcim/devices/?site=nyc-dc1")

Performance Checklist

  • Using ?brief=True for list operations
  • Excluding config_context when not needed
  • Using specific filters instead of ?q= search
  • Explicit pagination with appropriate page sizes

References

See skills/netbox-integration-best-practices/references/rules/perf-*.md for detailed rules.

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. 3d ago First seen · 68 lines · 0 tokens per session scan A 466a28bee24f

Subscribe to this mod's changes

netbox-performance is a cursor rule published in the GitHub repository netboxlabs/netbox-best-practices (29 stars, last pushed 6mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 431 tokens. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.