Skip to main content
Glama

Brightpearl MCP by usefulapi

Search product categories

brightpearl_search_categories
Read-only

Search Brightpearl product categories; each row has id, name, parentId, active, createdOn, updatedOn. GET /product-service/brightpearl-category-search.

Input Schema

NameRequiredDescriptionDefault
nameNoCategory name.
activeNoOnly active (true) or inactive (false) categories.
page_sizeNoRows per page, 1-500 (default 25).
parent_idNoOnly the children of this category; 0 = the top-level categories.
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

B3.2/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 useful context by listing the fields returned in each row and the underlying endpoint, but says nothing about pagination limits or result caps beyond what the schema implies.

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 compact sentence that front-loads the action and resource, then summarizes return fields. Nothing is wasted, though the endpoint path is of marginal use to an agent.

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 read-only paginated search with no output schema, the description supplies the key return-field list and the schema fully documents filtering and paging. It is nearly complete, missing only explicit guidance on result limits or how paging terminates.

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 every parameter (name, active, page_size, parent_id, first_result) is already well documented, including the next_first_result paging hint. The description adds no parameter meaning beyond that, 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+resource ('Search Brightpearl product categories') and enumerates the returned row fields, making the resource distinct from siblings like search_products and search_brands. It stops short of naming an explicit alternative, so it lands at 4 rather than 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus the sibling search/filter tools, nor any prerequisites or exclusions. Usage is only implied by the verb 'Search' and the resource name.

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.