Skip to main content
Glama

Update Circuit

netbox_update_circuit
DestructiveIdempotent

Update an existing circuit in NetBox by providing its numeric ID and only the fields to change. Unchanged fields remain as is.

Instructions

Update an existing circuit 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 circuit to update.
cidNo
tagsNoOptional array of tag slugs to apply to the object.
typeNo
statusNo
tenantNo
commentsNo
providerNo
commit_rateNo
descriptionNo
install_dateNo
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
provider_accountNo
termination_dateNo
Behavior4/5

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

The description explicitly states PATCH semantics and that omitted fields remain unchanged, which adds behavioral context beyond annotations. All annotations are consistent (e.g., idempotentHint=true aligns with PATCH). No contradictions.

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 extremely concise: two short paragraphs plus a one-line return summary. Every sentence is essential and front-loaded with the core purpose. No wasted words.

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

Completeness3/5

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

Given the tool has 15 parameters and no output schema, the description is somewhat minimal. It covers core behavior but lacks details on field constraints, typical usage, and the structure of the returned data. Adequate for simple use but not fully complete.

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 27% schema description coverage, the description should compensate more. It only explains that 'id' is required and fields are optional changeable, but does not elaborate on any other parameters or their typical values. Most parameters are left unexplained.

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 'Update an existing circuit in NetBox' with specific verb and resource. It distinguishes from sibling create/get tools by emphasizing PATCH semantics and the need to supply only changed fields.

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?

The description provides clear guidance: supply numeric 'id' and only fields to change, omitting others leaves them unchanged. It also notes output format options. However, it does not explicitly contrast with other tools or warn when not to use this tool.

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