Skip to main content
Glama

List Console_server_ports

netbox_list_console_server_ports
Read-onlyIdempotent

Retrieve a paginated list of console server ports from NetBox. Filter by device, name, or type for targeted network inventory queries.

Instructions

List device console server ports from NetBox.

Supports pagination and filtering. Common patterns:

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

  • Lookup by id: use netbox_get_console_server_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
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, destructiveHint. Description adds valuable behavior beyond annotations: pagination details (limit, offset, has_more, next_offset), auto-truncation for large lists, response format options (markdown/json), and return shape.

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?

Well-organized into clear sections: purpose, common patterns, pagination, filters, and returns. Front-loaded with core purpose. Every sentence adds value; no redundancy.

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 parameters, no output schema, and good annotations, the description covers usage patterns, pagination, filter types, and response format. Could mention typical fields in items but remains adequate for a list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 58% (7/12 params described). Description lists resource-specific filters but provides no additional detail beyond the schema's own descriptions. Universal filters (q, tag, created_after/before) are explained. Does not significantly add meaning for undocumented parameters.

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?

Description clearly states 'List device console server ports from NetBox' (verb+resource). Distinguishes from sibling tool netbox_get_console_server_port by noting it is for lookup by id. Common patterns further clarify usage.

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?

Explicit guidance on when to use (discovery with no filters, narrow scan with filters) and when not to (lookup by id use netbox_get_console_server_port). Also explains pagination continuation pattern.

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