Skip to main content
Glama

Update Virtual_disk

netbox_update_virtual_disk
DestructiveIdempotent

Update specific fields of a virtual disk in NetBox. Only supplied values are changed, leaving other attributes intact.

Instructions

Update an existing virtual_disk 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 virtual_disk to update.
nameNo
sizeNo
tagsNoOptional array of tag slugs to apply to the object.
descriptionNo
custom_fieldsNoOptional object of custom-field slugs -> values. Only include fields defined on your NetBox instance.
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?

Description reveals PATCH semantics, partial update behavior, and return format (Markdown/JSON). Annotations already indicate idempotent and destructive; description adds context beyond annotations without contradiction.

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?

Concise and well-structured: first line states purpose, second gives usage guidance, third describes return options. Every sentence adds value with no redundancy.

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?

For a mutation tool with no output schema, description covers all essential aspects: update semantics, required id, optional fields, and response format. Adequate for correct tool selection and invocation.

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

Parameters4/5

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

Schema covers 57% of parameters with descriptions. Description adds value by explaining that omitted fields remain unchanged and the id is required. Response_format parameter gets extra clarification on when to use JSON vs Markdown.

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?

Clearly states the action (Update) and resource (virtual_disk) with explicit PATCH semantics. Distinguishes from sibling tools like create_virtual_disk and get_virtual_disk.

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 instructs to supply numeric 'id' and only fields to change, emphasizing omitting fields leaves them unchanged. Could mention when not to use, but sufficient for use.

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