Skip to main content
Glama

List Device_roles

netbox_list_device_roles
Read-onlyIdempotent

Fetch device roles (core-switch, leaf, hypervisor, etc.) from NetBox with support for pagination and filtering by name, slug, VM role, tags, and creation date.

Instructions

List device roles (core-switch, leaf, hypervisor, etc.) from NetBox.

Supports pagination and filtering. Common patterns:

  • Discovery: call with no filters to browse the first device_roles.

  • Lookup by id: use netbox_get_device_role instead when you already have an id.

  • Narrow scan: combine 'q' (fuzzy text) with resource-specific filters below.

Pagination:

  • 'limit' (max 1000, default 50) and 'offset'. Response includes 'has_more' and 'next_offset'.

  • Large list responses auto-truncate to keep under the character limit; keep calling with next_offset to continue.

Resource-specific filters:

  • name: Exact name.

  • slug: Exact slug.

  • vm_role: Whether this role applies to VMs.

Universal filters:

  • q (string) Fuzzy text search across searchable fields.

  • tag (string[]) AND-filter by tag slugs.

  • created_after (date) ISO-8601 lower bound on 'created'.

  • created_before (date) ISO-8601 upper bound on 'created'.

Returns: Markdown summary (default) or JSON with shape: { total, count, offset, limit, items: [...], has_more, next_offset? }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoFuzzy full-text search across the object's searchable fields (name, description, etc.).
tagNoFilter to objects that have ALL of these tag slugs. Repeat for multiple tags (AND semantics in NetBox).
nameNoExact name.
slugNoExact slug.
limitNoMaximum number of items to return per page (1-1000, default 50).
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
vm_roleNoWhether this role applies to VMs.
created_afterNoISO-8601 date; only return objects created on or after this date (e.g. 2024-01-01).
created_beforeNoISO-8601 date; only return objects created on or before this date.
response_formatNoOutput format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls.markdown
Behavior5/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint true, and destructiveHint false. The description goes beyond by detailing pagination auto-truncation, the 'has_more' and 'next_offset' response fields, and the option to return either markdown or JSON. No contradiction with 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?

The description is well-structured with clear headers (Common patterns, Pagination, Resource-specific filters, Universal filters, Returns). Each section is concise and purposeful. The most critical information (purpose and when to use) is front-loaded. Every sentence adds value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (10 parameters, pagination, no output schema), the description is thorough. It explains return format (Markdown or JSON shape with all fields), pagination details, and all filter categories. It also differentiates from sibling tools effectively. No gaps remain.

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 coverage is 100%, so baseline is 3. The description adds value by grouping parameters into 'resource-specific filters' and 'universal filters', explaining common usage patterns for each, and providing examples (e.g., 'ISO-8601 date'). This enhances understanding beyond the schema descriptions alone.

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 explicitly states the verb 'list' and the resource 'device roles', with examples like 'core-switch, leaf, hypervisor'. It clearly differentiates from the sibling tool 'netbox_get_device_role' by specifying that the latter is for lookup by id. This meets the criteria for a specific verb+resource with sibling differentiation.

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

Usage Guidelines5/5

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

The description provides explicit usage patterns: 'Discovery: call with no filters', 'Lookup by id: use netbox_get_device_role instead', and 'Narrow scan: combine q with filters'. It also explains pagination usage and when to use subsequent calls. This is a model of clear when-to-use guidance.

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