Skip to main content
Glama

Brightpearl MCP by usefulapi

Get order notes

brightpearl_get_order_notes
Read-only

All notes on one order (text, author contact id, date, whether it is public on the customer portal, the order status at the time). GET /order-service/order/{id}/note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
order_idYesOrder id.

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 cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=true). The description adds value beyond them by listing what each note contains (text, author contact id, date, customer-portal visibility, order status at the time) and citing the underlying endpoint path. It omits pagination/result-limit behavior, which is the main remaining gap.

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?

Two tight clauses: the returned content first, then the endpoint. No filler sentences, and the core purpose is front-loaded ahead of the field enumeration.

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 is what makes this definition sufficient to call correctly. What is missing is edge-case behavior (empty note list, pagination, ordering of notes), which keeps it short of a 5.

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% and there is only one parameter (order_id), which the schema already documents. The description adds no extra meaning such as id format or where to obtain the id; 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+scope: all notes on one order, with the returned fields enumerated. It implicitly distinguishes itself from the write-side siblings brightpearl_add_order_note and brightpearl_add_contact_note, but never names an alternative 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?

The read-only framing implies this is the retrieval counterpart to brightpearl_add_order_note, but there is no explicit 'use this when...' guidance, no note about when to prefer search_orders or the goods-in/out note searches instead.

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.