Brightpearl MCP by usefulapi

io.usefulapiPublished by usefulapi.ioOfficial publisherv1.19.4Updated Nov 7, 2026

Search Brightpearl orders, products, stock, contacts and payments; add notes, update order status.

The publisher's own server: Ably MCP by usefulapi

VerifiedStreamable HTTPWeb executableFinanceData & AnalyticsBusiness & Commerce

Overview

AI-generated overview

Hosted Brightpearl connector that lets an assistant search orders, products, stock, contacts and payments, add notes and change order status.

What you can do
  • Search and read sales and purchase orders, credits, order notes, statuses and types
  • Search products, brands and categories, and read prices, price lists and per-warehouse stock availability
  • Search contacts and read full contact records, including financial terms and addresses
  • Search goods-in and goods-out notes, warehouses, shipping methods, customer payments, payment methods and tax codes
  • Add notes to orders and contacts, and move an order to another status
  • Check usage, request a feature, upgrade or cancel the subscription
When to use it
Useful when you want to ask questions about a Brightpearl account in plain language, such as which orders are still unshipped, how much stock a SKU has per warehouse, or what a customer has paid, and occasionally record a note or advance an order's status.
Requirements
A remote MCP endpoint; no local install. Sign-in is via OAuth, and the login page asks for the reference and token of a private app in your own Brightpearl account. Add only the server URL to the client config, with no Authorization header or API key. A free plan allows 50 tool calls per month; paid plans are available.
Before you install
Two tools write to Brightpearl: adding order or contact notes and changing order status. Notes marked public appear on the customer portal and cannot be removed with this server, and status changes can trigger the account's alerts and automations. The login page asks for private-app credentials. Paid plans are billed through a checkout link, and cancelling gives no refund for the current period.

Installation

In SourceWeft

  1. Open Brightpearl MCP by usefulapi in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/io.usefulapi%2Fbrightpearl/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "brightpearl-by-usefulapi": {
      "type": "http",
      "url": "https://brightpearl.usefulapi.io/mcp"
    }
  }
}

README

Brightpearl MCP by usefulapi

Use Brightpearl from Claude, Cursor, or any MCP client — search sales and purchase orders, products, prices, stock availability per warehouse, goods-in and goods-out notes, contacts and customer payments, add notes to orders and contacts, and update an order's status (each write needs an explicit confirmation). Hosted, no local install: connect with the reference and token of a private app in your own Brightpearl account.

Live endpoint: https://brightpearl.usefulapi.io/mcp · Homepage: https://usefulapi.io/brightpearl

Connect

  • Claude (claude.ai, Desktop): open Customize → Connectors, click + Add → Add custom connector, and paste https://brightpearl.usefulapi.io/mcp.
  • Claude Code: claude mcp add --transport http brightpearl https://brightpearl.usefulapi.io/mcp, then run /mcp to log in.
  • VS Code: Add to VS Code.
  • Cursor and other clients: add the URL as a remote MCP server:
json
{  "mcpServers": {    "brightpearl": {      "url": "https://brightpearl.usefulapi.io/mcp"    }  }}

Add only the URL. Do not add an Authorization header or an API key to the client config: the server signs you in with OAuth, and the login page asks for your Brightpearl credentials.

Step-by-step setup, where to find your credentials, and FAQ: https://usefulapi.io/brightpearl/

Tools

ToolTypeWhat it does
brightpearl_get_account_configurationreadGet account configuration
brightpearl_search_ordersreadSearch orders
brightpearl_get_ordersreadGet orders
brightpearl_get_order_notesreadGet order notes
brightpearl_list_order_statusesreadList order statuses
brightpearl_list_order_typesreadList order types
brightpearl_add_order_notewriteAdd order note
brightpearl_update_order_statuswriteUpdate order status
brightpearl_search_productsreadSearch products
brightpearl_get_productsreadGet products
brightpearl_get_product_pricesreadGet product prices
brightpearl_get_product_availabilityreadGet product stock availability
brightpearl_list_price_listsreadList price lists
brightpearl_search_brandsreadSearch brands
brightpearl_search_categoriesreadSearch product categories
brightpearl_list_warehousesreadList warehouses
brightpearl_list_shipping_methodsreadList shipping methods
brightpearl_search_goods_out_notesreadSearch goods-out notes (shipments)
brightpearl_search_goods_in_notesreadSearch goods-in notes (stock received)
brightpearl_search_contactsreadSearch contacts
brightpearl_get_contactsreadGet contacts
brightpearl_add_contact_notewriteAdd contact note
brightpearl_search_customer_paymentsreadSearch customer payments
brightpearl_list_payment_methodsreadList payment methods
brightpearl_list_tax_codesreadList tax codes
brightpearl_usage_statusmetaUsage status (free-tier meter)
brightpearl_request_featuremetaRequest a missing feature
brightpearl_upgrademetaUpgrade to Pro or Pro+
brightpearl_cancel_subscriptionmetaCancel the Pro subscription

read tools are read-only; write tools mutate data (clients should confirm them); meta tools report usage, manage your subscription or send a feature request.

Pricing

PlanPriceLimit
Free$050 tool calls / month
Pro (per account)$9/mo or $90/yr (2 months free)Unlimited*

*Pro has a fair use limit of 10,000 tool calls a month on this server. For more, write to [email protected].

Pro covers this server only. Subscribe with brightpearl_upgrade (it returns a Stripe Checkout link). Cancel any time with brightpearl_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running brightpearl_upgrade before then undoes the cancel. Or write to [email protected].

License

MIT © usefulapi. Not affiliated with or endorsed by Brightpearl.

Source: servers/brightpearl/README.md at commit 4046075

Tools

25

brightpearl_get_account_configuration

Get account configuration

The Brightpearl account's configuration as key/value pairs: base currency, tax scheme, time zone, default and new-order status ids, nominal codes, weight unit, whether multiple warehouses are enabled. GET /integration-service/account-configuration.

Takes no parameters.

brightpearl_search_orders

Search orders

Search sales orders, sales credits, purchase orders and purchase credits. Every filter is optional and they combine (AND); each result row has orderId, orderTypeId, contactId, orderStatusId, orderStockStatusId, createdOn, updatedOn, customerRef, externalRef, warehouseId and more. Use brightpearl_get_orders for the full order. Order type ids: brightpearl_list_order_types; status ids: brightpearl_list_order_statuses. GET /order-service/order-search.

Parametersis_closedorder_idspage_sizeplaced_tocontact_idcreated_toupdated_toplaced_fromcreated_fromcustomer_refexternal_reffirst_result+8 more

brightpearl_get_orders

Get orders

Full details of one or more orders by id: type, status, payment/stock/shipping status, dates, currency, totals, assignment, customer/supplier, billing and delivery parties, and the order rows (product, quantity, price, tax). Up to 50 ids. GET /order-service/order/{ids}.

Parametersorder_idsrequiredinclude_custom_fields

brightpearl_get_order_notes

Get order notes

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.

Parametersorder_idrequired

brightpearl_list_order_statuses

List order statuses

The account's order statuses (id, name, order type code SO/PO/SC/PC, sort order, disabled, visible to the customer, state such as draft). Use the ids to filter orders or to change an order's status. GET /order-service/order-status.

Takes no parameters.

brightpearl_list_order_types

List order types

The four order types with their ids and codes (1 SO sales order, 2 PO purchase order, 3 SC sales credit, 4 PC purchase credit), for the order search. GET /order-service/order-type.

Takes no parameters.

brightpearl_add_order_note

Add order note

WRITE: add a note to an existing order. The note is private (staff only) unless is_public is true, which makes it visible on the customer portal. Returns the new note id. Notes cannot be removed with this server. POST /order-service/order/{id}/note.

Parameterstextrequiredorder_idrequiredis_public

brightpearl_update_order_status

Update order status

WRITE: move an existing order to another status (ids from brightpearl_list_order_statuses; the new status must exist, be visible and belong to this order's type). Brightpearl adds an order note on success, and status changes can trigger the account's alerts and automations. Moving a sales order to the account's 'cancelled' status removes its reservations and coupons and is refused while goods-out notes or payments exist. PUT /order-service/order/{id}/status.

Parametersnoteorder_idrequirednote_is_publicorder_status_idrequired

brightpearl_search_products

Search products

Search the product catalogue. Every filter is optional and they combine (AND); each result row has productId, productName, SKU, barcode, EAN, UPC, ISBN, MPN, stockTracked, createdOn, updatedOn, brightpearlCategoryCode, productGroupId, brandId, productTypeId, productStatus, primarySupplierId. Use brightpearl_get_products for full details. GET /product-service/product-search.

Parameterseanmpnskuupcisbnnamebarcodebrand_idpage_sizecreated_toupdated_tocategory_id+10 more

brightpearl_get_products

Get products

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}.

Parametersproduct_idsrequiredinclude_custom_fields

brightpearl_get_product_prices

Get product prices

Prices of products per price list: for each product and price list the currency, SKU and the quantity-break price map (e.g. {"1":"12","100":"11"}). Up to 50 product ids; optionally only some price lists (ids from brightpearl_list_price_lists). GET /product-service/product-price/{product ids}/price-list/{price list ids}.

Parametersproduct_idsrequiredprice_list_ids

brightpearl_get_product_availability

Get product stock availability

Stock availability of stock-tracked products: for each product the totals across all warehouses (inStock, onHand, allocated, inTransit) and the same per warehouse; optionally per location, with on-order quantities. Up to 50 product ids. GET /warehouse-service/product-availability/{ids}.

Parameterson_orderby_locationproduct_idsrequired

brightpearl_list_price_lists

List price lists

The price lists (id, name, code, currency, SELL or BUY, gross or net). Id 0 is the cost price list. GET /product-service/price-list.

Takes no parameters.

brightpearl_search_brands

Search brands

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

Parametersnamepage_sizefirst_result

brightpearl_search_categories

Search product categories

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

Parametersnameactivepage_sizeparent_idfirst_result

brightpearl_list_warehouses

List warehouses

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.

Takes no parameters.

brightpearl_list_shipping_methods

List shipping methods

The shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method.

Takes no parameters.

brightpearl_search_goods_out_notes

Search goods-out notes (shipments)

Search goods-out notes, the pick/pack/ship records of sales orders; each row has goodsOutNoteId, printed, picked, packed, shipped, shippedOn, orderId, shippingMethodId, warehouseId, createdOn, releaseDate, transfer. GET /warehouse-service/goods-note/goods-out-search.

Parameterspackedpickedshippedorder_idpage_sizecreated_toshipped_tocreated_fromfirst_resultnewest_firstshipped_fromwarehouse_id+1 more

brightpearl_search_goods_in_notes

Search goods-in notes (stock received)

Search goods-in records (stock received against purchase orders, by batch and location); each row has purchaseOrderId, batchId, productId, locationId, price, currCode, receivedQuantity, onHand, createdDate, receivedDate, warehouseId. GET /warehouse-service/goods-in-search.

Parametersbatch_idpage_sizeproduct_idreceived_tofirst_resultnewest_firstwarehouse_idreceived_frompurchase_order_id

brightpearl_search_contacts

Search contacts

Search contacts (customers, suppliers and staff). Every filter is optional and they combine (AND); each result row has contactId, primaryEmail, firstName, lastName, companyName, isSupplier, isStaff, isCustomer, createdOn, updatedOn, lastOrderedOn and more. Use brightpearl_get_contacts for the full record. GET /contact-service/contact-search.

Parametersemailphonetag_idsis_stafflast_namepage_sizecreated_tofirst_nameupdated_tocompany_idscontact_idsis_customer+9 more

brightpearl_get_contacts

Get contacts

Full records of one or more contacts by id: name, emails, phones, status, supplier/staff flags, financial details (price list, tax code, credit limit and terms), assignment, organisation, tags, dates; optionally custom fields and the full postal addresses. Up to 50 ids. GET /contact-service/contact/{ids}.

Parameterscontact_idsrequiredinclude_addressesinclude_custom_fields

brightpearl_add_contact_note

Add contact note

WRITE: add a note to a contact's timeline (for example a record of correspondence). The note is private (staff only) unless is_public is true, which makes it visible on the customer portal. Returns the new note id. Notes cannot be removed with this server. POST /contact-service/contact/{id}/note.

Parameterstextrequiredis_publiccontact_idrequired

brightpearl_search_customer_payments

Search customer payments

Search payments received against sales orders; each row has paymentId, transactionRef, paymentMethodCode, paymentType, orderId, currencyCode, amountAuthorized, amountPaid, paymentDate, createdOn, journalId. GET /accounting-service/customer-payment-search.

Parametersorder_idspage_sizecreated_topayment_topayment_idscreated_fromfirst_resultnewest_firstpayment_frompayment_typetransaction_refpayment_method_code

brightpearl_list_payment_methods

List payment methods

The payment methods (name, code, active, bank accounts with currency and nominal code). GET /accounting-service/payment-method.

Takes no parameters.

brightpearl_list_tax_codes

List tax codes

The tax codes (id, code, description, rate). GET /accounting-service/tax-code.

Takes no parameters.

Version history

16
  1. v1.19.4LatestNov 7, 2026
  2. v1.18.3Nov 5, 2026
  3. v1.18.2Nov 5, 2026
  4. v1.18.1Nov 4, 2026
  5. v1.18.0Nov 3, 2026
  6. v1.17.1Nov 3, 2026
  7. v1.16.0Nov 1, 2026
  8. v1.14.0Oct 31, 2026
  9. v1.13.0Oct 31, 2026
  10. v1.12.2Oct 30, 2026
  11. v1.12.0Oct 30, 2026
  12. v1.7.0Oct 26, 2026
  13. v1.4.3Oct 25, 2026
  14. v1.4.0Oct 25, 2026
  15. v1.3.0Oct 24, 2026
  16. v1.0.1Oct 23, 2026

Score

100% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

Other Usefulapi integrations