Skip to main content
Glama

Brightpearl MCP by usefulapi

Search orders

brightpearl_search_orders
Read-only

Search sales orders, sales credits, purchase orders and purchase credits. Every filter is optional and they combine (AND); each result row has orderId, orderTypeId, contactId, orderStatusId, orderStockStatusId, createdOn, updatedOn, customerRef, externalRef, warehouseId and more. Use brightpearl_get_orders for the full order. Order type ids: brightpearl_list_order_types; status ids: brightpearl_list_order_statuses. GET /order-service/order-search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
is_closedNoWhether the order is invoiced (closed).
order_idsNoOnly these orders (one or more ids).
page_sizeNoRows per page, 1-500 (default 25).
placed_toNoPlaced: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.
contact_idNoOnly orders of this customer/supplier contact id.
created_toNoCreated: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.
updated_toNoLast updated: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.
placed_fromNoPlaced: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.
created_fromNoCreated: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.
customer_refNoCustomer reference of the order.
external_refNoExternal reference of the order (for example the web shop's order number).
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 (highest id) first. Default: oldest first.
updated_fromNoLast updated: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.
warehouse_idNoOnly orders for these warehouses (one or more ids).
order_type_idNoOrder type id (1 sales order, 2 purchase order, 3 sales credit, 4 purchase credit; see brightpearl_list_order_types).
order_status_idNoOrder status id (brightpearl_list_order_statuses).
payment_status_idNoOrder payment status id.
id_or_external_refNoMatches an order id OR an external reference (case-insensitive match).
shipping_status_idNoOrder shipping status id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so safety is covered. The description adds useful behavior: filter combination semantics and the shape of each result row (a summary, not the full order). It does not state result caps or pagination limits beyond what the schema implies, which keeps it just short of a 5.

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?

Front-loaded and dense; the routing hints come immediately after the scope statement. The trailing 'GET /order-service/order-search' is transport noise and 'and more' in the field list is slightly imprecise, costing a point but not readability.

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

Completeness5/5

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

For a 20-parameter, zero-required search with no output schema, the description supplies the missing pieces: what a result row contains, how filters combine, how to resolve enum-like ids, and where to go for full detail. An agent can construct and follow up on a query from this alone.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% across 20 params, so the baseline is 3. The description still contributes: the AND-combination rule for filters is a genuine semantic addition not expressed in the schema, and it clarifies that results are summary rows keyed by orderId rather than full orders.

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?

Opens with a specific verb and the exact resource families covered (sales orders, sales credits, purchase orders, purchase credits), so the agent knows precisely what this returns. It also names brightpearl_get_orders as the tool for full order detail, cleanly separating it from the sibling.

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

Usage Guidelines5/5

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

States that all filters are optional and combine with AND, which tells the agent how to build a query. It explicitly routes the agent onward for the two most likely follow-ups: brightpearl_get_orders for the full order and brightpearl_list_order_types / brightpearl_list_order_statuses to resolve ids.

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.