Skip to main content
Glama

Update Interface

netbox_update_interface
DestructiveIdempotent

Update specific fields of an existing NetBox interface by supplying its numeric ID and only the values you want to change. Returns a markdown summary or JSON.

Instructions

Update an existing interface in NetBox (PATCH semantics — only provided fields are changed).

Supply the numeric 'id' and only the fields you want to change. Omitting a field leaves it unchanged.

Returns: Markdown summary of the updated object (default) or JSON with the full NetBox response.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesNumeric id of the interface to update.
lagNo
mtuNo
vrfNo
wwnNo
modeNo
nameNo
tagsNoOptional array of tag slugs to apply to the object.
typeNo
labelNo
speedNo
bridgeNo
duplexNo
moduleNo
parentNo
enabledNo
poe_modeNo
poe_typeNo
mgmt_onlyNo
descriptionNo
mac_addressNo
tagged_vlansNo
custom_fieldsNoOptional object of custom-field slugs -> values. Only include fields defined on your NetBox instance.
untagged_vlanNo
mark_connectedNo
response_formatNoOutput format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls.markdown
Behavior4/5

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

The description adds value beyond annotations by specifying PATCH semantics (idempotent behavior) and the return format (Markdown summary or JSON). The annotations already indicate idempotentHint=true and destructiveHint=true, and the description aligns without contradicting.

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?

The description is concise with three short paragraphs, each front-loaded with key information: purpose, usage, and return format. No wasted words; every sentence serves a purpose.

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

Completeness2/5

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

Given the high complexity (26 parameters, nested objects, low schema coverage), the description is insufficient. It does not explain critical fields or provide examples, leaving the agent with incomplete context for accurate invocation.

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

Parameters2/5

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

Schema description coverage is very low (15%), and the description does not explain the meaning of most parameters (e.g., 'lag', 'mtu', 'vrf', 'mode', etc.). Only 'id' is mentioned, leaving the agent without sufficient context for correct parameter usage.

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

Purpose4/5

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

The description clearly states it updates an existing interface in NetBox with PATCH semantics. The verb 'update' and resource 'interface' are explicit. However, it does not differentiate from sibling tools like netbox_update_device, though the resource type provides implicit differentiation.

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?

The description explains that only the 'id' is required and omitted fields remain unchanged, providing minimal usage guidance. However, it lacks explicit when-to-use or when-not-to-use guidance, nor does it mention alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ZenixSolutions/netbox-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server