Skip to main content
Glama

get_inventory_levels

Retrieve available and committed inventory quantities for specific variants at specific locations. Filter by location or inventory item for precise stock tracking.

Instructions

Get inventory levels (available + committed quantities) for specific variants at specific locations. Filter by location_id, inventory_item_id, or both.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for offset pagination (1-indexed).
limitNoMax results per page (default 50, max 250).
location_idNoFilter by location ID (warehouse/store). Recommended for large catalogs.
inventory_item_idNoFilter by inventory item ID (equals variant_id in Sapo).
Behavior2/5

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It only states that it returns available + committed quantities; it does not mention pagination behavior, performance implications of unfiltered calls, authentication requirements, or any side effects. For a read operation, the lack of caveats about large result sets or required filters is a notable gap.

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 two concise sentences that front-load the core purpose and immediately follow with the key filtering guidance. Every word earns its place; there is no fluff or repetition of schema details. This is an ideal length and structure for a tool description.

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

Completeness3/5

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

Given there is no output schema and no annotations, the description should provide more context about expected return behavior and limitations. It does state the main return content (available + committed quantities) but does not mention that it returns a list, that unfiltered queries may return large volumes, or that pagination is available (only in schema). While not severely incomplete, it leaves the agent with some uncertainty about edge cases.

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 baseline is 3. The description adds value by clarifying that location_id and inventory_item_id can be used together ('or both'), which is not explicitly stated in the schema's individual parameter descriptions. This gives the agent a better understanding of how to combine filters, going beyond what the schema provides.

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 specific action ('Get inventory levels'), the resource ('available + committed quantities'), and the scope ('for specific variants at specific locations'). It also mentions the key filters, making it distinct from sibling tools like get_variant or get_product. This is a strong, specific purpose statement.

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

Usage Guidelines3/5

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

The description implies usage by stating it gets inventory for specific variants/locations and says 'Filter by location_id, inventory_item_id, or both.' However, it does not explicitly state when to prefer this tool over alternatives (though no sibling seems focused on inventory) or provide any exclusions or prerequisites. The guidance is minimal and mostly about filtering, not overall usage context.

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/nguyennguyenit/Sapo-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server