Skip to main content
Glama

List Purchases

netbox_list_purchases
Read-onlyIdempotent

List asset purchases from a supplier in NetBox, with filters for name, status, supplier, and date. Supports pagination for large result sets.

Instructions

List purchases of assets from a supplier (netbox-inventory plugin) from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • status: Purchase status: 'open', 'partial', or 'closed'.

  • supplier_id: Filter by supplier id.

  • date: Purchase date (ISO-8601, YYYY-MM-DD).

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).
dateNoPurchase date (ISO-8601, YYYY-MM-DD).
nameNoExact purchase 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.
statusNoPurchase status: 'open', 'partial', or 'closed'.
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.
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, non-destructive behavior. The description adds pagination details (limit, offset, has_more, next_offset), auto-truncation, and response format options, providing valuable context beyond 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 clear sections (common patterns, pagination, filters, returns) and is front-loaded. It is fairly long but 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?

With no output schema, the description fully explains the return structure (markdown or JSON shape). It covers pagination, filtering, and common patterns adequately for an 11-parameter non-mandatory tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 100% description coverage, and the description organizes parameters into 'Resource-specific filters' and 'Universal filters', adding semantic grouping. It also explains the response_format parameter for chaining, genuinely augmenting the schema.

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 action (list), resource (purchases), and context (netbox-inventory plugin). It differentiates from sibling netbox_get_purchase by advising to use that tool when an id is already known.

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?

The description outlines common patterns (discovery, lookup by id, narrow scan) and pagination usage. While it does not explicitly list when not to use, the contrast with netbox_get_purchase is 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