Skip to main content
Glama

Brightpearl MCP by usefulapi

Get product stock availability

brightpearl_get_product_availability
Read-only

Stock availability of stock-tracked products: for each product the totals across all warehouses (inStock, onHand, allocated, inTransit) and the same per warehouse; optionally per location, with on-order quantities. Up to 50 product ids. GET /warehouse-service/product-availability/{ids}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
on_orderNoAlso include quantities on open purchase orders (total and shipped).
by_locationNoAlso break the figures down by location within each warehouse.
product_idsYesProduct ids (1-50 ids).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description goes beyond them by disclosing the response structure (totals across warehouses plus per-warehouse figures, optional location breakdown, on-order quantities) and the 50-id batch limit, which materially affects how an agent plans calls. Missing only things like auth or rate-limit notes.

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?

Very dense and front-loaded: the core output fields come first, optional modes second, the batch limit next. The trailing endpoint path is marginally useful and nothing is wasted, though the single run-on structure is slightly harder to parse than a bulleted form.

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?

With no output schema, the description correctly shoulders the burden of describing return shape, and it does so well. It is nearly complete for a read-only availability lookup; only behavior for non-stock-tracked products or empty/invalid id results is unstated.

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 three parameters are already documented, making 3 the baseline. The description mirrors the optional flags ('optionally per location, with on-order quantities') without adding syntax, defaults, or edge-case meaning beyond the schema.

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 (retrieve stock availability for stock-tracked products) and enumerates the exact figures returned (inStock, onHand, allocated, inTransit). This clearly separates it from siblings like get_products or get_product_prices, which serve different data needs.

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 (query stock levels for up to 50 product ids) but never says when to choose this over get_products or search_products, nor names any alternative. The constraint that it only works for stock-tracked products is a useful implicit boundary, but routing guidance is left to inference.

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.