Skip to main content
Glama

Brightpearl MCP by usefulapi

Search goods-in notes (stock received)

brightpearl_search_goods_in_notes
Read-only

Search goods-in records (stock received against purchase orders, by batch and location); each row has purchaseOrderId, batchId, productId, locationId, price, currCode, receivedQuantity, onHand, createdDate, receivedDate, warehouseId. GET /warehouse-service/goods-in-search.

Input Schema

NameRequiredDescriptionDefault
batch_idNoOnly this batch.
page_sizeNoRows per page, 1-500 (default 25).
product_idNoOnly this product.
received_toNoReceived: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.
first_resultNoPosition of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page.
newest_firstNoNewest batch (highest batch id) first. Default: oldest first.
warehouse_idNoOnly this warehouse.
received_fromNoReceived: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.
purchase_order_idNoOnly stock received on this purchase order.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, non-destructive, openWorld), so the description's real contribution is the per-row field inventory (purchaseOrderId, batchId, receivedQuantity, onHand, etc.), which substitutes for the missing output schema and tells the agent exactly what it gets back. It omits any note on result volume or that paging uses next_first_result, though the schema covers that.

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?

The purpose is front-loaded in the opening clause and the endpoint anchor closes it; nothing reads as filler. The field enumeration is dense but earns its place because no output schema exists.

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 9-parameter, all-optional search tool with no output schema, the description supplies the missing return shape and endpoint, which is the main gap an agent would otherwise face. What remains absent, when to prefer this over related availability/order tools, is a usage rather than a completeness gap.

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% and every filter already documents itself (batch, product, warehouse, purchase order, received date range, paging, sort). The description only alludes to filtering 'by batch and location', adding no new semantics, so the baseline 3 applies.

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?

States a specific verb (search) and resource (goods-in records / stock received against purchase orders, by batch and location), which is concrete enough to distinguish it from the goods-out counterpart by name alone. It does not explicitly name any sibling as an alternative or exclusion, so it stops short of a 5.

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

Usage Guidelines2/5

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

No sentence says when to reach for this tool versus brightpearl_search_goods_out_notes, brightpearl_get_product_availability, or brightpearl_search_orders. The field list implies what questions it can answer, but no usage condition or exclusion is stated.

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.