Skip to main content
Glama

Update Site_group

netbox_update_site_group
DestructiveIdempotent

Update an existing NetBox site group by supplying its numeric ID and the fields to change. Unchanged fields remain as-is.

Instructions

Update an existing site_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 site_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
Behavior3/5

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

The annotations already mark the tool as destructive (destructiveHint: true) and idempotent (idempotentHint: true). The description adds 'PATCH semantics' which reinforces idempotency, but does not elaborate on any side effects or additional behavioral traits beyond what annotations provide. 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 sentences plus a return line. It front-loads the key behavior ('PATCH semantics') and keeps every sentence essential. No redundant or wasted text.

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 8 parameters and no output schema, the description provides adequate context on the update semantics and response format. However, it lacks details on parameter constraints (e.g., slug pattern, parent options) and custom_fields validation, leaving gaps for the agent to infer from the schema.

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?

Schema description coverage is 50% (only id and response_format have descriptions). The description does not provide additional meaning for the undocumented parameters (name, slug, tags, parent, description, custom_fields). It only says to include the fields to change, which is a general guideline, not specific parameter semantics.

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 site_group' with PATCH semantics. The verb 'update' and resource 'site_group' are explicit, and the tool is distinguished from sibling tools like get, create, and delete by the update action.

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 usage guidance: 'Supply the numeric 'id' and only the fields you want to change. Omitting a field leaves it unchanged.' This tells the agent when to use the tool (partial updates). However, it does not explicitly state when not to use it or list alternatives, though the context of siblings implies differentiation.

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