Skip to main content
Glama

Unleashed Software MCP by usefulapi

Get a product's stock

unleashed_get_product_stock
Read-only

Stock on hand for one product — totals, or broken down per warehouse with allWarehouses=true. The direct answer to 'how many do we have and where?'. Unleashed: GET /StockOnHand/{productGuid}[/AllWarehouses].

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
asAtDateNoStock on hand as at this date (YYYY-MM-DD).
productGuidYesThe product's Guid.
allWarehousesNoBreak the stock down per warehouse.
warehouseCodeNoOnly this warehouse (ignored with allWarehouses).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read, so the description's main added value is the underlying endpoint (GET /StockOnHand/{productGuid}[/AllWarehouses]) and the note that allWarehouses expands the breakdown. It does not describe pagination, error behavior for unknown GUIDs, or the response shape beyond the totals/per-warehouse split.

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?

Two tight sentences plus the endpoint reference; the primary mode is front-loaded and no sentence is filler.

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?

Adequate for a read-only, fully documented single-resource query. The description hints at the return structure (totals vs. per-warehouse), though with no output schema a brief note on the fields returned would make it airtight.

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 every parameter is already documented. The description reinforces the allWarehouses toggle and its effect on the result shape, which is a small addition over the schema's own wording.

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?

States a specific verb+resource ('Stock on hand for one product') and scopes it to a single product, which cleanly distinguishes it from the sibling unleashed_list_stock_on_hand. The two output modes (totals vs. per-warehouse) are named up front.

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 framing 'The direct answer to how many do we have and where?' communicates the use case clearly, and 'one product' implies the list variant is for the other case. It stops short of explicitly naming unleashed_list_stock_on_hand as the alternative for multi-product queries.

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.