MCP server

Brightpearl MCP by usefulapi

io.usefulapi/brightpearl

Checked 26 Oct 2026, 08:29 UTC · Connected to it and listed its tools

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

Website Source

At a glance

Type

MCP server

Publisher

usefulapi.io (verified by the MCP Registry)

Status

Working at last check

Tools

25

Token cost

About 7,997 tokens per request

Sets up in

Claude Code, Claude Desktop, Codex, Gemini CLI, Cursor, VS Code, Antigravity, ChatGPT, OpenAI API, Grok

Last checked

26 Oct 2026, 08:29 UTC

Connect it to your agent

Add to CursorAdd to VS CodeVS Code Insiders

Opens the app, which shows the server and asks you to confirm. For other apps, copy the setup below.

Claude Code

claude mcp add --transport http brightpearl https://brightpearl.usefulapi.io/mcp

Claude Desktop

Settings → Connectors → Add custom connector, and paste the URL.

Codex (config.toml)

[mcp_servers.brightpearl]
url = "https://brightpearl.usefulapi.io/mcp"

Gemini CLI

{"mcpServers":{"brightpearl":{"httpUrl":"https://brightpearl.usefulapi.io/mcp"}}}

Cursor

{"mcpServers":{"brightpearl":{"url":"https://brightpearl.usefulapi.io/mcp"}}}

VS Code

{"servers":{"brightpearl":{"type":"http","url":"https://brightpearl.usefulapi.io/mcp"}}}

Antigravity

agy mcp add brightpearl https://brightpearl.usefulapi.io/mcp

ChatGPT

Settings → Apps & Connectors → Advanced settings: turn on Developer mode, then Create a connector and paste the URL. Which plans can do this varies.

OpenAI API (Responses tools)

{"type":"mcp","server_label":"brightpearl","server_url":"https://brightpearl.usefulapi.io/mcp","require_approval":"always"}

Grok (xAI API tools)

{"type":"mcp","server_label":"brightpearl","server_url":"https://brightpearl.usefulapi.io/mcp"}

Tools

• brightpearl_add_contact_note ~228 tokens
  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_add_order_note ~212 tokens
  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_get_account_configuration ~120 tokens
  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_get_contacts ~243 tokens
  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/
• brightpearl_get_order_notes ~130 tokens
  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_get_orders ~221 tokens
  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_product_availability ~253 tokens
  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_get_product_prices ~254 tokens
  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-l
• brightpearl_get_products ~231 tokens
  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/produ
• brightpearl_list_order_statuses ~114 tokens
  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 ~98 tokens
  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_list_payment_methods ~84 tokens
  The payment methods (name, code, active, bank accounts with currency and nominal code). GET /accounting-service/payment-method.
• brightpearl_list_price_lists ~84 tokens
  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_list_shipping_methods ~80 tokens
  The shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method.
• brightpearl_list_tax_codes ~68 tokens
  The tax codes (id, code, description, rate). GET /accounting-service/tax-code.
• brightpearl_list_warehouses ~95 tokens
  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_search_brands ~204 tokens
  Search product brands by name; each row has brandId, brandName, createdOn, updatedOn. GET /product-service/brand-search.
• brightpearl_search_categories ~278 tokens
  Search Brightpearl product categories; each row has id, name, parentId, active, createdOn, updatedOn. GET /product-service/brightpearl-category-search.
• brightpearl_search_contacts ~947 tokens
  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 r
• brightpearl_search_customer_payments ~629 tokens
  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_search_goods_in_notes ~472 tokens
  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_goods_out_notes ~617 tokens
  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_orders ~1000 tokens
  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
• brightpearl_search_products ~1003 tokens
  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 bri
• brightpearl_update_order_status ~332 tokens
  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 t

Browse

• Website monitoring
• Payments
• Invoicing and accounting
• Shipping and parcels

Related MCP servers

• Unleashed Software MCP by usefulapi
  Check products, stock on hand, customers, orders, invoices and quotes, and create records.
• Cin7 Core MCP by usefulapi
  Read Cin7 Core products, stock by location, sales, purchases, customers, suppliers and transfers.
• Sapo MCP by usefulapi
  Read Sapo store products, orders, customers and stock levels; edit order notes and stock.
• Megaventory MCP by usefulapi
  Read Megaventory products, stock, orders and partners; create clients, sales and purchase orders.
• KiotViet MCP by usefulapi
  Read KiotViet products, customers, invoices, orders and stock; create customers and orders.
• Sellasist MCP by usefulapi
  Read Sellasist orders, products, stock, customers, invoices, returns; add order notes, set status.
• Ecwid MCP by usefulapi
  Read store products, orders, customers, categories and coupons; adjust inventory and update orders.
• sevdesk MCP by usefulapi
  Look up contacts, invoices, vouchers, orders, bank transactions and parts, and create drafts.

Badge for your README

[![AptLynx](https://aptlynx.net/badge/io.usefulapi/brightpearl.svg)](https://aptlynx.net/servers/io.usefulapi/brightpearl)

Listing text is written by the maker; AptLynx lists tools and does not vouch for them. Find another tool · Browse by topic · For agents