Skip to main content
Glama

Brightpearl MCP by usefulapi

List order statuses

brightpearl_list_order_statuses
Read-only

The account's order statuses (id, name, order type code SO/PO/SC/PC, sort order, disabled, visible to the customer, state such as draft). Use the ids to filter orders or to change an order's status. GET /order-service/order-status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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, destructiveHint=false, so safety is covered. The description adds value beyond that by enumerating the exact fields returned (including the SO/PO/SC/PC order type codes and the draft state), which matters because there is no output schema; the endpoint path also confirms it is a plain GET listing. It does not mention whether the list is paginated or whether it includes system/hidden statuses.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with what the tool returns and followed by the concrete use of the ids. The parenthetical field enumeration is dense but every item earns its place given the absence of an output schema.

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 zero-parameter read tool with annotations covering the safety profile, the description does the heavy lifting by describing the returned record shape. What is missing is minor: no note on whether the full set is returned or whether disabled/hidden statuses are included, and no explicit pointer to the update tool for the change-status workflow.

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?

The tool takes zero parameters, so the baseline of 4 applies; there is no parameter semantics gap because there is nothing to document. The description correctly implies a no-argument, account-scoped listing.

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 the specific resource (the account's order statuses) and enumerates the fields returned (id, name, order type code, sort order, disabled, customer visibility, state), plus the underlying GET endpoint. It is clearly a read/list operation distinct from mutation siblings, though it never explicitly contrasts itself with the similarly-named brightpearl_list_order_types.

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?

"Use the ids to filter orders or to change an order's status" gives a concrete downstream purpose, which is good implied guidance. However, it never names the alternatives an agent would need — brightpearl_update_order_status for the actual change and brightpearl_search_orders for the filtering — nor states any when-not-to-use condition.

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.