Skip to main content
Glama

List Inventory_item_groups

netbox_list_inventory_item_groups
Read-onlyIdempotent

List inventory item groups from NetBox with pagination and filtering by name, parent group, tags, and creation date. Supports fuzzy text search.

Instructions

List inventory item groups (netbox-inventory plugin) from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • name: Exact group name.

  • parent_id: Parent group id (for nested groups).

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).
nameNoExact group name.
limitNoMaximum number of items to return per page (1-1000, default 50).
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
parent_idNoParent group id (for nested groups).
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 readOnly, openWorld, idempotent, and non-destructive hints. The description adds pagination details (limit, offset, auto-truncation) and return shape, which are useful. No contradictions. Slightly less than 5 because annotations cover most safety aspects.

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-organized with clear sections (common patterns, pagination, filters, returns). It uses bullet points and is concise without unnecessary repetition. Every sentence adds value.

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 listing tool with 9 parameters and no output schema, the description covers all necessary aspects: purpose, usage patterns, pagination behavior, detailed filter descriptions, and return format. It is complete and self-contained.

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 100%, so parameters are well-documented in schema. The description adds value by grouping filters into 'resource-specific' and 'universal', explaining 'q' fuzzy search, AND-tag semantics, and default/max for 'limit'. This exceeds the baseline of 3.

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 'List inventory item groups' and distinguishes from the sibling 'netbox_get_inventory_item_group' by recommending it for ID-based lookup. It also specifies the plugin context, making the resource unambiguous.

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 patterns: discovery, lookup by ID (with alternative tool), and narrow scan with filters. It also tells when not to use (when ID is known, use get tool), which is excellent guidance.

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