Skip to main content
Glama

List Aggregates

netbox_list_aggregates
Read-onlyIdempotent

List aggregate prefixes from RIRs in NetBox. Supports pagination and filtering by prefix, family, RIR, tenant, tags, and date range.

Instructions

List aggregate prefixes from RIRs from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • prefix:

  • family:

  • rir_id: RIR id (e.g. ARIN, RIPE).

  • 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).
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.
prefixNo
rir_idNoRIR id (e.g. ARIN, RIPE).
tenant_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 indicate read-only, idempotent, open-world. Description adds pagination details (limit, offset, has_more, next_offset), auto-truncation, and output format options. 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?

Well-structured with clear sections (resource-specific, universal, pagination, patterns). Front-loaded purpose. No redundant sentences; every part adds value.

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?

Covers all 11 parameters, pagination behavior, output format, and usage patterns. Very complete for a listing tool with no output schema, though lacks mention of sorting or performance.

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 73%, so description adds value by explaining q fuzzy search, tag AND semantics, date formats, and rir_id example. However, some parameters (prefix, family, tenant_id) have blank descriptions both in schema and description, missing full compensation.

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 it lists aggregate prefixes from RIRs, with specific verb and resource. It distinguishes from netbox_get_aggregate by advising to use that for lookup by id.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit patterns: discovery, lookup by id, and narrow scan. Includes pagination and format options. Lacks explicit 'when not to use' but the alternatives are clear.

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