Skip to main content
Glama

Brightpearl MCP by usefulapi

Search brands

brightpearl_search_brands
Read-only

Search product brands by name; each row has brandId, brandName, createdOn, updatedOn. GET /product-service/brand-search.

Input Schema

NameRequiredDescriptionDefault
nameNoBrand name (case-insensitive match).
page_sizeNoRows per page, 1-500 (default 25).
first_resultNoPosition of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so safety is covered. The description adds useful context beyond annotations: the exact row shape (brandId, brandName, createdOn, updatedOn) and the underlying endpoint, which help an agent interpret results.

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 compact clauses: the action with its key filter and returned fields, then the endpoint. Nothing is wasted and the core purpose is front-loaded.

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 required parameters and no output schema, the description appropriately covers what a caller needs: the searchable field and the returned row fields. Pagination details are already in the schema, so nothing critical is missing.

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 description coverage is 100%, so all three parameters are fully documented in the schema, including pagination guidance. The description's 'by name' adds no meaning beyond the schema's 'Brand name (case-insensitive match).' 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 ('Search product brands by name') and names the returned fields, so it is clearly distinct from search_products or search_categories. It does not explicitly contrast with siblings, but the resource scope is unambiguous.

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 implied: use this to find brands by name. There is no explicit when-to-use/when-not-to-use guidance or mention of alternatives, and it doesn't clarify that name is optional (all brands can be listed).

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.