Skip to main content
Glama

List Assets

netbox_list_assets
Read-onlyIdempotent

Browse or search hardware inventory assets in NetBox with pagination and filters for name, serial, status, kind, and more.

Instructions

List hardware inventory assets (netbox-inventory plugin) from NetBox.

Supports pagination and filtering. Common patterns:

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

  • Lookup by id: use netbox_get_asset 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 asset name.

  • name__ic: Asset name contains (case-insensitive).

  • serial: Exact serial number.

  • asset_tag: Exact asset tag.

  • status: Asset lifecycle status. Defaults in netbox-inventory are 'stored', 'used', 'retired' (your instance may define custom statuses).

  • kind: Hardware kind: 'device', 'module', 'inventoryitem', or 'rack'.

  • manufacturer_id: Filter by manufacturer id.

  • tenant_id: Filter by using-tenant id.

  • owning_tenant_id: Filter by owning-tenant (owner) id.

  • role_id: Filter by asset role id.

  • supplier_id: Filter by supplier id.

  • purchase_id: Filter by purchase id.

  • delivery_id: Filter by delivery id.

  • storage_location_id: Filter by storage location (dcim location) id.

  • inventoryitem_group_id: Filter by inventory item group id.

  • inventoryitem_type_id: Filter by inventory item type id.

  • device_id: Asset assigned to this device id.

  • module_id: Asset assigned to this module id.

  • rack_id: Asset assigned to this rack 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).
kindNoHardware kind: 'device', 'module', 'inventoryitem', or 'rack'.
nameNoExact asset 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.
serialNoExact serial number.
statusNoAsset lifecycle status. Defaults in netbox-inventory are 'stored', 'used', 'retired' (your instance may define custom statuses).
rack_idNoAsset assigned to this rack id.
role_idNoFilter by asset role id.
name__icNoAsset name contains (case-insensitive).
asset_tagNoExact asset tag.
device_idNoAsset assigned to this device id.
module_idNoAsset assigned to this module id.
tenant_idNoFilter by using-tenant id.
delivery_idNoFilter by delivery id.
purchase_idNoFilter by purchase id.
supplier_idNoFilter by supplier id.
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.
manufacturer_idNoFilter by manufacturer id.
response_formatNoOutput format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls.markdown
owning_tenant_idNoFilter by owning-tenant (owner) id.
storage_location_idNoFilter by storage location (dcim location) id.
inventoryitem_type_idNoFilter by inventory item type id.
inventoryitem_group_idNoFilter by inventory item group id.
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With readOnlyHint, idempotentHint, openWorldHint already provided, description adds pagination behavior (auto-truncation, next_offset) and output format details. Does not contradict 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?

Well-structured with sections for pagination, resource-specific filters, universal filters, and returns. Front-loaded with purpose. Some repetition of parameter details already in schema, but necessary for clarity given 26 parameters.

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?

Comprehensive for a list tool: covers pagination, all filtering options, output format, and alternative tool usage. No output schema needed as return shape is described. No gaps given the tool's complexity.

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 description coverage is 100%, so baseline is 3. Description adds value by explaining pagination parameters, default statuses, and response_format usage for chaining. Some repetition but overall enhanced semantics.

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 it lists hardware inventory assets using a specific plugin. Distinguishes from sibling tool netbox_get_asset for single asset lookup via explicit 'use netbox_get_asset instead' guidance.

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?

Provides explicit patterns: discovery (no filters), lookup by id (directs to sibling), narrow scan (combine filters). Also explains pagination and when to use markdown vs json output.

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