Search Brightpearl orders, products, stock, contacts and payments; add notes, update order status. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"brightpearl": {
"url": "https://brightpearl.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"brightpearl": {
"type": "http",
"url": "https://brightpearl.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
The login page asks for your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token.
In Brightpearl open App Store → Private Apps → Add Private App (an account administrator with the settings permission). Choose a staff app (the token acts as one staff member and respects that member's permissions) or a system app (account token). Copy the app's reference and token. The account code and data centre are in your Brightpearl address: euw1.brightpearlapp.com/mycompany.login is data centre euw1, account mycompany. Your credentials are used only to call the Brightpearl API on your behalf; they are never shown to anyone.
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: the login page asks for your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the Brightpearl connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
brightpearl_get_account_configuration | read | 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. |
brightpearl_search_orders | read | 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. |
brightpearl_get_orders | read | 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}. |
brightpearl_get_order_notes | read | 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. |
brightpearl_list_order_statuses | read | 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. |
brightpearl_list_order_types | read | 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. |
brightpearl_add_order_note | write | 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. |
brightpearl_update_order_status | write | 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. |
brightpearl_search_products | read | 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. |
brightpearl_get_products | read | 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}. |
brightpearl_get_product_prices | read | 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}. |
brightpearl_get_product_availability | read | 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}. |
brightpearl_list_price_lists | read | 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. |
brightpearl_search_brands | read | Search brands Search product brands by name; each row has brandId, brandName, createdOn, updatedOn. GET /product-service/brand-search. |
brightpearl_search_categories | read | Search product categories Search Brightpearl product categories; each row has id, name, parentId, active, createdOn, updatedOn. GET /product-service/brightpearl-category-search. |
brightpearl_list_warehouses | read | 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. |
brightpearl_list_shipping_methods | read | List shipping methods The shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method. |
brightpearl_search_goods_out_notes | read | 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. |
brightpearl_search_goods_in_notes | read | 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. |
brightpearl_search_contacts | read | 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. |
brightpearl_get_contacts | read | 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}. |
brightpearl_add_contact_note | write | 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. |
brightpearl_search_customer_payments | read | 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. |
brightpearl_list_payment_methods | read | List payment methods The payment methods (name, code, active, bank accounts with currency and nominal code). GET /accounting-service/payment-method. |
brightpearl_list_tax_codes | read | List tax codes The tax codes (id, code, description, rate). GET /accounting-service/tax-code. |
brightpearl_usage_status | Usage status (free-tier meter) Report the caller's current free-tier usage this month: calls used, monthly limit, remaining, and whether the cap is reached. Read-only; does not count against the meter. | |
brightpearl_request_feature | Request a missing feature Tell usefulapi that the user needs something the Brightpearl tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
brightpearl_upgrade | Upgrade to Pro (unlimited) Subscribe to the Pro plan for UNLIMITED Brightpearl tool calls (the free tier caps monthly usage). Choose monthly ($9/month) or yearly ($90/year — 2 months free) billing. Returns a short link to open in your browser (it opens Stripe Checkout); after payment your account upgrades automatically. Does not count against the meter. | |
brightpearl_cancel_subscription | Cancel the Pro subscription Cancel the caller's Brightpearl Pro subscription at the end of the paid period (no refund for the current period; unlimited calls continue until then, then the free tier applies). Requires confirm: true. Run brightpearl_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper account | $9/mo · $90/yr | Unlimited |
Pro covers this Brightpearl 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].
No. usefulapi is an independent service. It is not affiliated with or endorsed by Brightpearl. The server calls the Brightpearl API with your own Brightpearl access, so it sees only the data that your account can see.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
The login page asks for your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token. See Before you connect for where to find them.
No. 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: the login page asks for your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Brightpearl API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in Brightpearl.
Yes, if you approve it. 3 of the 25 Brightpearl tools can create or change data. The other 22 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls, for this Brightpearl server only. Run brightpearl_usage_status to see how many calls you used.
Ask the AI to run brightpearl_upgrade: it returns a Stripe Checkout link. To cancel, run brightpearl_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with brightpearl_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.