Skip to main content
Glama

List Console_ports

netbox_list_console_ports
Read-onlyIdempotent

List device console ports from a NetBox instance, with optional filters by device, name, type, and full-text search. Supports pagination for browsing large inventories.

Instructions

List device console ports from NetBox.

Supports pagination and filtering. Common patterns:

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

  • Lookup by id: use netbox_get_console_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 readOnly, idempotent, openWorld, non-destructive. Description adds significant behavioral context: pagination behavior (limit max 1000, default 50, has_more/next_offset), auto-truncation for large lists, and return format options. 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?

Well-structured with clear sections: purpose, patterns, pagination, filters (grouped), return format. Every sentence contributes essential information. No fluff or repetition.

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?

For a list tool with rich annotations and no output schema, description covers all necessary aspects: pagination, filtering options, common use cases, return format. Combined with annotations, it provides complete guidance for agent invocation.

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%, and description adds meaningful context beyond schema: groups filters into 'resource-specific' and 'universal' categories, explains q as fuzzy text search, and clarifies tag as AND-filtered. Some params (device, name) lack descriptions in schema but description provides minimal context. Overall adds value but doesn't fully compensate for all omissions.

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?

Clearly states 'List device console ports from NetBox' – specific verb and resource. Distinguishes from sibling netbox_get_console_port by explicitly calling it out for single-record lookups. Provides common usage patterns (discovery, lookup by id, narrow scan).

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?

Explicitly advises using netbox_get_console_port when id is already known. Gives clear guidance on when to use no filters (discovery) vs combining q with specific filters. Pagination instructions are thorough with limit/offset and auto-truncation.

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