Skip to main content
Glama

List Cables

netbox_list_cables
Read-onlyIdempotent

List cables in NetBox by connecting endpoints. Filter by type, status, label, length, or search text; paginate through results.

Instructions

List cables connecting two endpoints from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • status:

  • type: Cable type slug (e.g. 'cat6', 'smf', 'mmf-om4').

  • label:

  • color: Hex color without the #.

  • length:

  • length_unit:

  • tenant_id:

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).
typeNoCable type slug (e.g. 'cat6', 'smf', 'mmf-om4').
colorNoHex color without the #.
labelNo
limitNoMaximum number of items to return per page (1-1000, default 50).
lengthNo
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
statusNo
tenant_idNo
length_unitNo
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 declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, destructiveHint=false. The description adds behavioral details like pagination with limit/offset, auto-truncation for large lists, and the response shape including 'has_more' and 'next_offset'. 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.

Conciseness5/5

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

The description is well-structured with clear sections: summary, common patterns, pagination, resource-specific filters, universal filters, and returns. Each sentence serves a purpose, no fluff, and it's concise while covering essential details.

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 complexity (14 parameters, no output schema), the description covers all necessary aspects: purpose, filtering, pagination, and return format. The annotations provide safety guarantees. The agent has enough context to use the tool correctly.

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?

The description adds value beyond the schema by explaining common patterns and some filter semantics (e.g., type slugs, color hex format, date filters). However, parameters like label, length, tenant_id, and status are listed without additional explanation, and schema coverage is 64%. Overall, it provides meaningful but not exhaustive guidance.

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 lists cables between two endpoints. It differentiates from sibling tools like netbox_get_cable and netbox_global_search, and explicitly mentions the specific resource (cables) and action (list).

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 guidance: use no filters for discovery, use netbox_get_cable for known IDs, and combine filters for narrow scans. Pagination handling and response format usage are also clearly explained.

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