Skip to main content
Glama

List stock levels

current_rms_list_stock_levels
Read-only

List stock levels — the individual serialised assets (asset number, serial number, location, store) or bulk stock quantities held. Pass product_id for one product's stock, or use filters such as {"asset_number_eq": "ABC-1234"} to find an asset. Current RMS: GET /stock_levels or GET /products/{product_id}/stock_levels.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number, starting at 1.
sortNoSort order, e.g. ["name asc"] or ["updated_at desc", "id asc"]. Add "id asc" when paging so the order is deterministic.
filtersNoExtra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {"updated_at_gt": "2026-01-01T00:00:00.000Z"}, {"number_eq": "003664"}, {"status_not_eq": 40}, {"work_email_address_eq": "abc@test.com"}, {"asset_number_eq": "ABC-1"}. Unknown predicates are silently ignored by the API.
includeNoAssociations to embed.
per_pageNoRecords per page, 1-100 (default 20).
product_idNoOnly this product's stock levels.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

readOnlyHint=true already declares this is a safe read, so the description need not restate safety. It adds the endpoint mapping and the asset-vs-bulk distinction, but says nothing about result volume, pagination limits, or how the two modes alter the returned shape. With annotations covering the safety profile, this is adequate but not rich.

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?

Two sentences, front-loaded with what a stock level is before the routing advice and endpoint citation. Efficient, though the endpoint tail is arguably redundant given the tool name prefix and the schema already carries the filter example.

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?

For a six-parameter read-only list tool with full schema coverage and no output schema, the description supplies the one thing structured fields cannot: what a 'stock level' actually represents. Pagination and nesting are handled by the schema, so nothing critical is missing.

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 page, per_page, sort, filters, include and product_id are all documented in the schema — including the same asset_number_eq filter example. The description's parameter content duplicates rather than extends the schema, so the baseline 3 applies.

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 and resource ('List stock levels') and then disambiguates what a stock level is — serialised assets (asset number, serial number, location, store) versus bulk quantities — which no sibling name conveys. It also cites the backing endpoints (GET /stock_levels, GET /products/{product_id}/stock_levels), letting an agent map it against current_rms_list_product_inventories.

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?

Gives concrete routing guidance: 'Pass product_id for one product's stock, or use filters such as {"asset_number_eq": "ABC-1234"} to find an asset.' This tells an agent the two main usage modes. It stops short of naming an alternative tool or stating exclusions (e.g., when to prefer current_rms_list_product_inventories), so it is clear context without exclusions.

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.