Skip to main content
Glama
NetBox MCP Server

NetBox MCP Server

Official
by netboxlabs

netbox_get_object_by_id

Read-only

Retrieves detailed NetBox object information by object type and ID, with optional field filtering to reduce response size and token usage.

Instructions

Get detailed information about a specific NetBox object by its ID.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "object_type": "<object_type>",
      "object_id": "<object_id>"
    },
    "name": "netbox_get_object_by_id"
  }
}

Input Schema

NameRequiredDescriptionDefault
briefNoreturns only a minimal representation of the object in the response. This is useful when you need only a summary of the object without any related data.
fieldsNoOptional list of specific fields to return **IMPORTANT: ALWAYS USE THIS PARAMETER TO MINIMIZE TOKEN USAGE** Field filtering reduces response payload by 80-90% and is critical for performance. - None or [] = returns all fields (NOT RECOMMENDED - use only when you need complete objects) - ['id', 'name'] = returns only specified fields (RECOMMENDED) Examples: - For basic info: ['id', 'name', 'status'] - For devices: ['id', 'name', 'status', 'site'] - For IP addresses: ['address', 'dns_name', 'vrf', 'status'] Uses NetBox's native field filtering via ?fields= parameter. **Always specify only the fields you actually need.**
object_idYesThe numeric ID of the object
object_typeYesString representing the NetBox object type (e.g. "dcim.device", "ipam.ipaddress")

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

B3.4/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this is a safe read, so the description only needs to add context beyond that. It adds nothing about what happens for a missing/invalid ID, whether access is permission-gated, or how response size is affected — the only such guidance lives in the schema's fields parameter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with zero wasted wording. It is efficient, though the brevity is partly under-specification rather than disciplined conciseness.

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?

With no output schema, the description should convey what "detailed information" means and how the brief/fields parameters shape it, but that burden is carried entirely by the schema. For a simple single-object read tool this is minimally adequate, not complete.

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 description coverage is 100%, so all four parameters (object_type, object_id, fields, brief) are fully documented in the schema itself. The description mentions no parameter at all, so it adds no meaning beyond structured data and the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource ("Get detailed information about a specific NetBox object") plus the lookup key (ID). That implicitly contrasts with listing/searching siblings like netbox_get_objects and netbox_search_objects, but no sibling is named, so differentiation is left to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"by its ID" implies the precondition that the caller already knows both object_type and object_id, which is a usable usage signal. However, there is no explicit when-to-use/when-not guidance and no pointer to netbox_get_objects or netbox_search_objects for the case where the ID is unknown.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.