Skip to main content
Glama

Update Contact_group

netbox_update_contact_group
DestructiveIdempotent

Update an existing contact group in NetBox by providing its numeric ID and the fields to change. Omitted fields remain unchanged.

Instructions

Update an existing contact_group 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 contact_group to update.
nameNo
slugNo
tagsNoOptional array of tag slugs to apply to the object.
parentNo
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?

The description adds behavioral context beyond annotations: it specifies PATCH semantics (modifies only provided fields) and describes the return format (markdown or JSON). Annotations already indicate destructive hint, so the description complements them well.

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 five sentences, well-structured, and front-loaded with the core purpose. Every sentence adds value without redundancy.

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

Completeness4/5

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

Given the complexity (8 parameters, nested objects) and the lack of output schema, the description covers the main usage points: PATCH behavior, required id, optional fields, and response format. It does not explicitly state that the contact group must exist, but that is implied. Overall, it is sufficiently complete.

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?

With 50% schema coverage, the description provides essential parameter guidance: it emphasizes that only the 'id' is required and that omitted fields are unchanged. It also explains the 'response_format' parameter and the nature of the response. This adds meaningful context that the schema alone does not fully convey.

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 verb ('Update'), the resource ('existing contact_group'), and the semantics ('PATCH semantics — only provided fields are changed'). This distinguishes it from sibling tools like create and delete.

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 explains how to use the tool ('Supply the numeric id and only the fields you want to change. Omitting a field leaves it unchanged.'). It does not explicitly specify when not to use it, but the context is clear.

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