Skip to content
MCP server

Brightpearl MCP by usefulapi

Search Brightpearl orders, products, stock, contacts and payments; add notes, update…

Install
Runs
Remotely
Version
1.23.0
Listing updated
4 days ago

About Brightpearl MCP by usefulapi

Brightpearl MCP by usefulapi is an MCP server for finance and payments. It runs as a hosted remote server, so there is nothing to install locally.

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

Install

Run in a terminal

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

Add to Settings → Connectors → Add custom connector

https://brightpearl.usefulapi.io/mcp
Install in CursorOpens Cursor, which asks you to confirm. Or add it by hand:

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "brightpearl": {
      "url": "https://brightpearl.usefulapi.io/mcp"
    }
  }
}
Install in VS CodeOpens VS Code, which asks you to confirm. Or add it by hand:

Add to .vscode/mcp.json

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

Add to ~/.codeium/windsurf/mcp_config.json

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

Add to your client's MCP settings (most use this shape)

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

Tools this server provides (25)

Read directly from the server.

brightpearl_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
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_li
brightpearl_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
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
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
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 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: 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
brightpearl_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
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
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
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
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
Search product brands by name; each row has brandId, brandName, createdOn, updatedOn. GET /product-service/brand-search.
brightpearl_search_categories
Search Brightpearl product categories; each row has id, name, parentId, active, createdOn, updatedOn. GET /product-service/brightpearl-category-search.
brightpearl_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
The shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method.
brightpearl_search_goods_out_notes
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
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
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
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 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
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
The payment methods (name, code, active, bank accounts with currency and nominal code). GET /accounting-service/payment-method.
brightpearl_list_tax_codes
The tax codes (id, code, description, rate). GET /accounting-service/tax-code.

Brightpearl MCP by usefulapi FAQ

How do I add Brightpearl MCP by usefulapi to Claude Code?

Run this command in your terminal: claude mcp add --transport http brightpearl https://brightpearl.usefulapi.io/mcp

What are the best alternatives to Brightpearl MCP by usefulapi?

The closest alternatives to Brightpearl MCP by usefulapi are Solana MCP by Vybe, Tapetide - Indian Stock Market MCP, Budget Tracker, Quantivex Research and Provyan.

Alternatives to Brightpearl MCP by usefulapi

  1. Remote MCP server exposing the Vybe Solana API to AI clients and code editors

    • 44 tools
    • Remote
    • 2.8K GitHub stars
    • Finance and payments
  2. Indian NSE and BSE stock market data for AI assistants through 48 MCP tools

    • 17 tools
    • Remote
    • Freemium
    • 150 GitHub stars
    • Finance and payments
  3. Budget Tracker

    MCP server

    Local MCP expense ledger that logs receipts and mileage, splits VAT and prepares rebilling

    • 14 tools
    • Remote
    • Freemium
    • 2 GitHub stars
    • Finance and payments
  4. Stock scores, what a price assumes, earnings quality and quiet profit revisions

    • 11 tools
    • Remote
    • Free
    • Finance and payments
  5. Provyan

    MCP server

    Backtested crypto signal results on 94 coins, with luck odds and sources

    • 4 tools
    • Remote
    • Free
    • Finance and payments
  6. TribuJus

    MCP server

    Read-only access to UK bank accounts, cards and transactions via TrueLayer Open Banking

    Not checked yet
    • 5 tools
    • Remote
    • Open source
    • Legal and government