Skip to main content
Glama

Update Tenant_group

netbox_update_tenant_group
DestructiveIdempotent

Update an existing tenant group in NetBox by providing its numeric ID and the fields to change. Only specified fields are modified.

Instructions

Update an existing tenant_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 tenant_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?

Annotations already indicate destructive and idempotent behavior. Description adds PATCH semantics detail but doesn't expand on auth, rate limits, or side effects 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?

Five sentences with front-loaded purpose and PATCH semantics. No fluff, every sentence adds value.

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?

Return format explained (markdown default or json). Nested custom_fields object mentioned but not detailed. Sufficient for the tool's complexity given annotations.

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?

Schema coverage is 50%, description clarifies id must be numeric and explains response_format default. However, parameters like name, slug, parent, description lack schema descriptions and are not elaborated in description.

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?

Explicitly states 'Update an existing tenant_group in NetBox (PATCH semantics)' with clear verb and resource. Distinguishes from siblings like create_tenant_group and get_tenant_group.

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 guidance: 'Supply the numeric id and only the fields you want to change. Omitting a field leaves it unchanged.' Does not explicitly exclude other actions but is sufficient.

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