Skip to main content
Glama

unleashed-software

List stock on hand

unleashed_list_stock_on_hand
Read-only

List stock on hand per product — QtyOnHand, AllocatedQty, AvailableQty, OnPurchase, AvgCost — optionally for one warehouse or as at a past date. Unleashed: GET /StockOnHand/{page}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (1-based). Default 1.
orderByNoSort column (default productCode).
asAtDateNoStock on hand as at this date (YYYY-MM-DD).
pageSizeNoRecords per page, 1-1000. Unleashed default is 200.
productIdNoOnly these product Guids (comma-separated).
isAssembledNoInclude quantity that can be assembled via auto-assembly BOMs in AvailableQty.
modifiedSinceNoOnly records created or modified since this UTC date (YYYY-MM-DD).
warehouseCodeNoOnly stock in this warehouse code.
warehouseNameNoOnly stock in this warehouse name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

The readOnlyHint annotation already establishes that this is a safe read operation. The description adds useful behavioral context by naming returned stock fields and showing the GET /StockOnHand/{page} endpoint, implying pagination, though it does not cover auth, rate limits, or the full response envelope.

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 compact sentence that front-loads the core operation and returned fields, then adds optional scoping and the API endpoint. Every clause contributes useful information without waste.

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

Completeness4/5

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

There is no output schema, so the description appropriately lists representative returned fields. With all input parameters documented at 100% coverage, the definition is largely complete for a read-only listing tool, though it stops short of fully describing pagination or response metadata.

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 all nine parameters are already documented in the input schema. The description reinforces warehouse and date filtering but adds no parameter syntax or format details beyond what the schema provides, making the baseline 3 appropriate.

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 states a specific verb and resource: list stock on hand per product, and names the key returned quantities. It clearly distinguishes stock-on-hand listing from broader product listing, though it does not explicitly contrast with the sibling get_product_stock tool.

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?

It indicates optional filtering by warehouse or historical date, which implies when these parameters are useful. However, it provides no explicit guidance on when to choose this tool over alternatives such as get_product_stock or list_stock_adjustments.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.