Skip to main content
Glama

List Ip_ranges

netbox_list_ip_ranges
Read-onlyIdempotent

Retrieve IP ranges from your NetBox instance with pagination and filters for address, status, tenant, and more.

Instructions

List IP ranges (start/end address pairs) from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • start_address:

  • end_address:

  • family:

  • vrf_id:

  • tenant_id:

  • status:

  • role_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).
limitNoMaximum number of items to return per page (1-1000, default 50).
familyNo
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
statusNo
vrf_idNo
role_idNo
tenant_idNo
end_addressNo
created_afterNoISO-8601 date; only return objects created on or after this date (e.g. 2024-01-01).
start_addressNo
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?

The description adds valuable behavioral context beyond annotations: details about pagination (limit, offset, 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.

Conciseness4/5

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

The description is well-structured with sections and clear first sentence. Although lengthy, the information is organized and front-loaded. Every sentence adds value, but some redundancy exists in listing filter names without new info.

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 14 parameters, no output schema, and annotations, the description covers purpose, pagination, filtration types, and return format. Lacks detailed explanation of each filter's semantics, but overall 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?

The description lists parameter names but adds little semantic meaning beyond the input schema. Schema coverage is 50%, and the description does not clarify filter behavior (e.g., start_address exact match or prefix? status enum meaning). Baseline of 3 is appropriate as the schema already provides some descriptions.

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 starts with a clear verb+resource: 'List IP ranges (start/end address pairs) from NetBox.' It explicitly distinguishes from the sibling tool netbox_get_ip_range, saying to use that instead when an id is available.

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 (no filters), lookup by id (with alternative), and narrow scan (combining filters). It also explains pagination mechanics and when to use json vs markdown format.

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