Skip to main content
Glama

List Rear_ports

netbox_list_rear_ports
Read-onlyIdempotent

List rear ports from NetBox with pagination and filtering. Browse all ports or narrow results by device, name, or type for efficient discovery.

Instructions

List patch-panel rear ports from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • type:

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
typeNo
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=true, idempotentHint=true, destructiveHint=false. Description adds key behavioral details: pagination with has_more/next_offset, auto-truncation, return format (markdown/json), and filter semantics (AND for tags). No contradictions.

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?

Description is well-structured with sections for common patterns, pagination, and filters. It is front-loaded with the main action. While lengthy, every section adds value. Could be slightly more concise but remains effective.

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 12 optional parameters and no output schema, description covers pagination mechanics, return shape (Markdown or JSON with fields), and filter types. Lacks detailed field descriptions for items and exact semantics of name__ic, but overall sufficient for a list tool. With output schema missing, some reliance on inference remains.

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 58%. Description compensates by grouping filters (resource-specific, universal) and explaining 'q', 'tag', date filters, and pagination params. Some filters like 'name__ic' are listed but not fully explained (likely case-insensitive contains), leaving minor gaps.

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 states 'List patch-panel rear ports from NetBox.' as a specific verb+resource. It explicitly distinguishes from netbox_get_rear_port by recommending it for ID lookups, and from other list tools by specifying 'rear ports'.

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?

Provides explicit when-to-use patterns: discovery, lookup by id (with alternative), and narrow scan. Includes pagination guidance, response truncation, and continuation instructions. Clearly differentiates from sibling get tool.

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