Skip to main content
Glama
AIops-tools

io.github.AIops-tools/network-aiops

netbox_get_device

Read-only

Retrieve a single NetBox device by exact name to support device inventory lookup, automation, and source-of-truth integration.

Instructions

[READ] Return a single NetBox device by exact name.

Args: name: Exact NetBox device name (see netbox_list_devices).

Input Schema

NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.0

TDQS

A3.6/5.0
Behavior3/5

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

readOnlyHint=true already declares the safe-read profile, so the '[READ]' tag is redundant. It does add one behavioral fact beyond annotations — matching is by EXACT name, so no fuzzy/partial lookup — but says nothing about error behavior for a missing device.

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?

Extremely tight: a one-line purpose sentence plus a single arg note, with the READ marker and core purpose front-loaded. Nothing wasted.

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?

For a one-parameter read-only lookup this is close to adequate, but with no output schema the description never indicates what the returned device contains, and it omits failure behavior when the exact name does not match.

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?

Schema description coverage is 0%, so the description must carry the parameter semantics. It does tell the agent the value must be an exact device name and points to netbox_list_devices as the source of valid values, which is meaningful beyond the bare string type. Format/case conventions are still unspecified.

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?

States a specific verb ('Return') and resource ('a single NetBox device') with the exact-name scope. It points at netbox_list_devices, which implicitly distinguishes this single-record lookup from the list variant, though it never states the distinction explicitly.

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?

The parenthetical '(see netbox_list_devices)' hints at where to obtain the name and implies this tool is for when you already have one. There is no explicit when-to-use/when-not-to-use statement or stated precondition (device must exist).

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