Skip to main content
Glama

Brightpearl MCP by usefulapi

List warehouses

brightpearl_list_warehouses
Read-only

The warehouses (id, name, type, address id, click-and-collect settings, weekly operating hours). Use the ids for stock and order filters. GET /warehouse-service/warehouse.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is covered. The description adds the returned field set and the HTTP endpoint, which is useful since no output schema exists, but says nothing about volume, pagination, or whether inactive/closed warehouses are included.

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?

Three short fragments with no filler: what a warehouse record is, what the ids are for, and the endpoint. The purpose statement is front-loaded and every clause carries information.

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

Completeness3/5

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

For a zero-param read tool with no output schema, listing the response fields is the right move and partly fills the gap. Still missing are scope details an agent would want — whether all warehouses are returned at once, whether inactive ones appear, and whether there is any pagination or filtering.

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?

There are zero parameters and schema coverage is 100%, so there is nothing for the description to disambiguate. Baseline 4 applies; the field enumeration describes the response rather than the inputs.

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?

The description names the resource (warehouses) and enumerates what each record contains (id, name, type, address id, click-and-collect settings, weekly operating hours), plus the backing endpoint GET /warehouse-service/warehouse. The listing verb is implicit rather than stated, and there is no sibling differentiation, but no sibling in the tool set covers warehouses so confusion risk is low.

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 for stock and order filters' gives one concrete downstream use case, which is real guidance. However it never states when to call this versus alternatives, or any prerequisite/exclusion — the when-to-use is only implied by the id-filtering note.

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.