Skip to main content
Glama

Update Interface_template

netbox_update_interface_template
DestructiveIdempotent

Update an existing NetBox interface template using PATCH semantics — only supplied fields are modified, others remain unchanged.

Instructions

Update an existing interface_template 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_template to update.
nameNo
typeNo
labelNo
bridgeNo
enabledNo
poe_modeNo
poe_typeNo
mgmt_onlyNo
descriptionNo
device_typeNo
module_typeNo
response_formatNoOutput format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls.markdown
Behavior3/5

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

Annotations provide safety profile; description adds PATCH semantics detail and return format options. Lacks side-effect disclosure, but idempotentHint aligns with PATCH behavior.

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?

Four concise sentences front-loading purpose, usage, and return information. No unnecessary words.

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?

For a tool with 13 parameters and no output schema, the description is incomplete. Does not describe most parameters or provide examples; return format is specified but not detailed.

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?

With only 15% schema description coverage, the description should compensate but only mentions 'id' and 'response_format'. No explanation of other 11 parameters leaves a significant gap.

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 clearly states the tool updates an existing interface_template, specifying PATCH semantics and distinguishing from create/get/delete siblings.

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

Usage Guidelines4/5

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

Explicitly states that only provided fields are changed and omitted fields remain unchanged, giving clear usage instructions. However, no mention of when not to use or 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