Skip to main content
Glama

List Device_bays

netbox_list_device_bays
Read-onlyIdempotent

List device bays from NetBox with pagination and filtering. Supports fuzzy search, tags, date ranges, and more.

Instructions

List bays that hold child devices from NetBox.

Supports pagination and filtering. Common patterns:

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

  • Lookup by id: use netbox_get_device_bay 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:

  • device_id:

  • device:

  • name:

  • name__ic:

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).
nameNo
limitNoMaximum number of items to return per page (1-1000, default 50).
deviceNo
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
name__icNo
device_idNo
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, and destructiveHint. The description adds valuable behavioral context: pagination details (limit, offset, has_more, next_offset), auto-truncation of large lists, and the response format (Markdown or JSON with shape). No contradictions 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.

Conciseness4/5

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

The description is well-structured with clear sections (purpose, common patterns, pagination, filters, returns) and front-loads the core purpose. Every sentence adds value, though the tool has many filters making it necessarily somewhat lengthy.

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?

Given 11 parameters, no output schema, and annotations covering safety, the description covers pagination behavior, filter semantics, return format, and alternatives. It is fairly complete for a list tool, though could mention that the tool is read-only (already in annotations).

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 64%, and the description compensates by explaining the pagination parameters (limit, offset) and universal filters (q, tag, created_after, created_before) in detail. Resource-specific filters are listed but lack descriptions; however, the description adds context for usage patterns (e.g., combining q with filters) beyond the schema.

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 clearly states the tool's purpose: 'List bays that hold child devices from NetBox.' It uses specific verb+resource ('List device_bays') and distinguishes from siblings like netbox_get_device_bay (for lookup by id) and netbox_create_device_bay / netbox_update_device_bay.

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_bay instead', and 'Narrow scan: combine q with resource-specific filters.' It also gives pagination instructions and mentions auto-truncation, offering clear guidance on when to use this tool versus alternatives.

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