Skip to main content
Glama

Brightpearl MCP by usefulapi

Get orders

brightpearl_get_orders
Read-only

Full details of one or more orders by id: type, status, payment/stock/shipping status, dates, currency, totals, assignment, customer/supplier, billing and delivery parties, and the order rows (product, quantity, price, tax). Up to 50 ids. GET /order-service/order/{ids}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
order_idsYesOrder ids (1-50 ids).
include_custom_fieldsNoAlso return the order's custom field values (includeOptional=customFields,nullCustomFields).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/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 adds real context beyond that: the batch cap of 50 ids, the breadth of the payload including order rows, and the underlying endpoint path. It stops short of describing behavior on missing/invalid ids, which is the one meaningful gap.

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?

A single dense sentence front-loads the core action and the field inventory, followed by the endpoint reference. It is information-packed rather than bloated, though the long field enumeration is somewhat list-like rather than scannable.

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 field enumeration usefully tells the agent what comes back, which is the main thing the description must compensate for. Error handling for nonexistent ids is the remaining omission, but for a read-only batch getter this is close to complete.

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 coverage is 100%, with both order_ids (1-50) and include_custom_fields documented inline, so the schema carries the parameter burden. The description's 'Up to 50 ids' merely restates maxItems and adds nothing about include_custom_fields or id validity, 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 and resource ('Full details of one or more orders by id') and enumerates the returned fields, so the agent knows exactly what it retrieves. The 'by id' scoping implicitly separates it from brightpearl_search_orders, but the sibling is never named, so differentiation requires inference.

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?

Usage is only implied: fetching known ids is the natural reading of 'by id', and the 50-id cap hints at batch lookups. There is no explicit statement of when to prefer this over brightpearl_search_orders or what to do when ids are unknown, so the agent must infer the routing.

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.