network-aiops

Overview Schema Source Related Servers Discussions Admin

netbox_list_devices

Read-only

List NetBox devices with name, role, site, status, and primary IP. Use this to confirm intended state before pushing configuration to a device.

Instructions

[READ] List NetBox devices (name, role, site, status, primary IP).

Requires a configured NetBox block. Use this to confirm intended state before pushing config to a device.

Returns {"devices": [...], "returned": N, "limit": L, "truncated": bool}. When truncated is true the estate is larger than what you were shown — re-run with a higher limit before concluding anything about coverage.

Args: name: Optional name filter (contains match). limit: Maximum devices to return (default 50).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "netbox_list_devices"
  }
}

Input Schema

Name	Required	Description	Default
`name`	No
`limit`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.8.0Jul 29, 2026

TDQS

A4.3/5.0

Behavior4/5

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

readOnlyHint already covers the safety profile, so the description's added value is meaningful: it discloses the prerequisite ('Requires a configured NetBox block'), the exact return envelope, and the truncation behavior with an actionable remedy. Pagination offset/cursor behavior is not covered, keeping it at 4.

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?

Front-loads the action and scope, then follows with prerequisite, usage, return shape, and args in a scannable order. Slightly verbose (the truncation warning spans two sentences) but every sentence carries operational 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?

With no output schema, the description supplies the return shape and truncation semantics, which is exactly what an agent needs to avoid false conclusions about coverage. It omits guidance on how to page beyond raising 'limit' and does not route to sibling tools for drill-down.

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 load, and it does: 'name' is explained as a contains match (real semantics beyond the bare string type) and 'limit' gets a stated default. Minor gap: no mention of whether name matching is case-sensitive or how limit interacts with the truncation threshold.

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?

States a specific verb and resource ('List NetBox devices') and enumerates the returned fields (name, role, site, status, primary IP). The [READ] prefix plus 'List' cleanly distinguishes it from the sibling netbox_get_device, which fetches a single device.

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?

Explicitly states the use case: 'confirm intended state before pushing config to a device,' which ties it into the config_* workflow siblings. It does not name an explicit alternative or exclusion (e.g., when to prefer netbox_get_device), so it stops short of a 5.

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