Skip to main content
Glama

Update Device_bay_template

netbox_update_device_bay_template
DestructiveIdempotent

Update specific fields of an existing device bay template in NetBox without affecting unmodified values.

Instructions

Update an existing device_bay_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 device_bay_template to update.
nameNo
labelNo
descriptionNo
device_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 already convey key traits (destructiveHint=true, idempotentHint=true, readOnlyHint=false). The description adds minimal extra context by confirming PATCH semantics and return format, but does not disclose additional behavioral traits beyond annotations.

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 (3-4 lines), front-loaded with the core purpose and PATCH semantics, followed by essential usage instructions and return format details. Every sentence adds value with no fluff.

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

Completeness5/5

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

Despite no output schema, the description adequately explains the return format (Markdown summary or JSON) and the usage pattern. For a simple update tool with clear annotations, this is sufficient context.

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?

With only 33% schema description coverage, the description partially compensates by clarifying that 'id' is required and explaining the 'response_format' parameter's purpose. However, it does not add meaning to other parameters (name, label, description, device_type) beyond what the schema provides.

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 action ('Update') and the resource ('device_bay_template'), and specifies PATCH semantics with only provided fields changed, distinguishing it 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?

Provides clear instructions: supply numeric 'id' and only fields to change, omitting leaves unchanged. However, it lacks explicit guidance on when not to use (e.g., for creation or deletion) and does not mention alternatives among siblings.

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