Skip to main content
Glama
mhajder

NetBox MCP Server

by mhajder

Netbox Delete Object

netbox_delete_object
Destructive

Permanently delete one NetBox object by app.model type and ID; dependent objects like device interfaces may be removed, so confirm with the user first.

Instructions

Permanently delete one NetBox object. Dependent objects may be deleted with it (e.g. a device's interfaces). Confirm with the user first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
object_idYesNumeric object ID.
object_typeYesNetBox object type as 'app.model' (e.g. 'dcim.device', 'ipam.ipaddress', 'virtualization.virtualmachine') or as an API path ('dcim/devices'). netbox_list_object_types lists every type.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and non-idempotency, but the description adds genuinely new behavioral context: deletion is permanent and cascades to dependent objects (interfaces of a device). That cascade disclosure is the kind of consequence an agent cannot infer from the annotations alone. It stops short of describing failure modes when dependents block deletion.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the destructive action and its scope, followed by the cascade warning and the confirmation requirement. Every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained. Combined with 100% schema coverage and rich annotations, the description supplies the remaining critical context (permanence, cascade, user confirmation). Only the behavior on delete failure or dependency constraints is unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters (object_id, object_type) are already fully documented in the schema, including the 'app.model' format and a pointer to netbox_list_object_types. The description adds no parameter-level detail, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Permanently delete') and resource ('one NetBox object'), and the singular scope ('one') implicitly distinguishes it from the sibling netbox_bulk_delete_objects. An agent can route between the single and bulk delete tools without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives one operational instruction ('Confirm with the user first'), which is useful but is about process, not tool selection. It never states when to prefer this over netbox_bulk_delete_objects or what preconditions (e.g. dependency checks) must hold, so usage is only implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.