MCP VTEX Server

vtex_list_inventory_by_warehouse

Retrieve inventory items for a specific warehouse to monitor stock levels and manage product availability in your VTEX e-commerce platform.

Instructions

List all inventory items in a warehouse

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "warehouseId": "<warehouseId>"
    },
    "name": "vtex_list_inventory_by_warehouse"
  }
}

Input Schema

Name	Required	Description	Default
`warehouseId`	Yes	Warehouse ID
`page`	No	Page number

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Jan 10, 2026

TDQS

C2.9/5.0

Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic operation. It doesn't disclose whether this is a read-only operation, whether it requires specific permissions, if there are rate limits, what format the inventory items are returned in, or if there are pagination details beyond the 'page' parameter. For a list operation with zero annotation coverage, this is insufficient.

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 a single, clear sentence with zero wasted words. It's front-loaded with the core purpose and appropriately sized for a simple list operation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a list operation with no annotations and no output schema, the description is too minimal. It doesn't explain what 'inventory items' include (SKUs, quantities, etc.), doesn't mention pagination behavior despite having a page parameter, and provides no context about authentication requirements or error conditions.

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 description coverage is 100%, so the schema already documents both parameters (warehouseId and page) adequately. The description adds no additional parameter information beyond what's in the schema, so it meets the baseline for high schema coverage without compensating value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('List all inventory items') and resource ('in a warehouse'), making the purpose immediately understandable. It doesn't specifically differentiate from sibling tools like 'vtex_get_inventory' or 'vtex_list_skus', but the warehouse-specific focus is reasonably clear from the description itself.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'vtex_get_inventory' or 'vtex_list_skus'. There's no mention of prerequisites, limitations, or comparison with sibling tools that might serve similar purposes.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server