Skip to main content
Glama

Brightpearl MCP by usefulapi

Get products

brightpearl_get_products
Read-only

Full details of one or more products by id: identity (SKU, barcodes), brand, type, stock-tracking, weight and dimensions, tax code, sales-channel names/descriptions/categories, bundle composition, variations, per-warehouse reorder levels, supplier and status. Up to 50 ids. GET /product-service/product/{ids}.

Input Schema

NameRequiredDescriptionDefault
product_idsYesProduct ids (1-50 ids).
include_custom_fieldsNoAlso return 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, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuinely useful context beyond that: the retrieval is id-keyed and capped at 50 ids per call, plus the breadth of what is returned. It says nothing about behavior with unknown or invalid ids.

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 with purpose, then a dense field enumeration, then the batching limit. Slightly noisy because the raw endpoint string duplicates what the server already knows, but the rest earns its place.

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 does the job of telling an agent what comes back, and the 50-id cap sets expectations for batching. Missing only edge-case behavior for unknown ids and any hint about the optional custom-fields flag.

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%, so both product_ids and include_custom_fields are already documented. The description's 'Up to 50 ids' restates the schema's maxItems and adds no syntax or format detail, and include_custom_fields is not mentioned at all.

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 products by id') and enumerates the returned facets, which makes clear it is a detail-fetch keyed on ids. The 'by id' phrasing implicitly distinguishes it from brightpearl_search_products, but no sibling is named explicitly.

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: an agent must infer it should call this when it already has product ids and use brightpearl_search_products otherwise. No alternative or prerequisite is stated explicitly.

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.