Brightpearl MCP by usefulapi

io.usefulapi由 usefulapi.io 發布官方發布者v1.19.5更新於 Nov 8, 2026

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

發布方自己的服務:Ably MCP by usefulapi

已驗證Streamable HTTP可網頁執行金融資料與分析商業與電商

概覽

AI 產生的概覽

託管的 Brightpearl 連接器,讓助理搜尋訂單、商品、庫存、聯絡人與付款,新增備註並變更訂單狀態。

可以做什麼
  • 搜尋並讀取銷售訂單、採購訂單、折讓單、訂單備註、狀態與類型
  • 搜尋商品、品牌與分類,讀取價格、價格表及各倉庫庫存可用量
  • 搜尋聯絡人並讀取完整聯絡人紀錄,包括財務條件與地址
  • 搜尋進貨單與出貨單、倉庫、運送方式、客戶付款、付款方式與稅碼
  • 為訂單與聯絡人新增備註,並將訂單改為其他狀態
  • 查看用量、提出功能需求、升級或取消訂閱
適用情境
適合以自然語言查詢 Brightpearl 帳戶的情況,例如哪些訂單尚未出貨、某 SKU 在各倉庫的庫存量、客戶已支付多少,偶爾也可記錄備註或推進訂單狀態。
執行需求
遠端 MCP 端點,無需本機安裝。透過 OAuth 登入,登入頁要求填寫你自己 Brightpearl 帳戶中私有應用程式的 reference 與 token。用戶端設定只填伺服器 URL,不要加入 Authorization 標頭或 API 金鑰。免費方案每月 50 次工具呼叫,另有付費方案。
安裝前請注意
有兩個寫入工具:新增訂單或聯絡人備註、變更訂單狀態。標示為公開的備註會顯示在客戶入口網站,且無法透過此伺服器刪除;狀態變更可能觸發帳戶的提醒與自動化。登入頁會索取私有應用程式憑證。付費方案透過結帳連結計費,取消後當期不退款。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Brightpearl MCP by usefulapi,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Web executable,透過 Streamable HTTP。 遠端服務在工作區中設定後即可從網頁執行環境執行。

交給代理程式安裝

把這段提示詞貼上到 Claude Code、Codex、Cursor 等代理程式,或 SourceWeft 對話中。代理程式會讀取該伺服器的安裝指南,先向你展示發布者、端點和登入方式,經你同意後再把它新增到你的客戶端。金鑰不會寫進任何命令。

閱讀 https://sourceweft.com/mcp/io.usefulapi%2Fbrightpearl/install.md,並按其中說明把這個 MCP 伺服器接入我的客戶端。修改任何設定之前,先告訴我它的發布者、端點和登入方式,等我確認。不要把 API 金鑰寫進命令或我會提交的檔案;問我金鑰應從哪裡取得。

檢視代理程式所依據的安裝指南

其他 MCP 客戶端

把它新增到你客戶端的 mcpServers 設定中。

{
  "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.

來源:servers/brightpearl/README.md,提交 4046075

工具

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.

無需輸入參數。

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.

輸入參數is_closedorder_idspage_sizeplaced_tocontact_idcreated_toupdated_toplaced_fromcreated_fromcustomer_refexternal_reffirst_result另有 8 個

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

輸入參數order_ids必填include_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.

輸入參數order_id必填

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.

無需輸入參數。

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.

無需輸入參數。

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.

輸入參數text必填order_id必填is_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.

輸入參數noteorder_id必填note_is_publicorder_status_id必填

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.

輸入參數eanmpnskuupcisbnnamebarcodebrand_idpage_sizecreated_toupdated_tocategory_id另有 10 個

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

輸入參數product_ids必填include_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}.

輸入參數product_ids必填price_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}.

輸入參數on_orderby_locationproduct_ids必填

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.

無需輸入參數。

brightpearl_search_brands

Search brands

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

輸入參數namepage_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.

輸入參數nameactivepage_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.

無需輸入參數。

brightpearl_list_shipping_methods

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

輸入參數packedpickedshippedorder_idpage_sizecreated_toshipped_tocreated_fromfirst_resultnewest_firstshipped_fromwarehouse_id另有 1 個

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.

輸入參數batch_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.

輸入參數emailphonetag_idsis_stafflast_namepage_sizecreated_tofirst_nameupdated_tocompany_idscontact_idsis_customer另有 9 個

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

輸入參數contact_ids必填include_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.

輸入參數text必填is_publiccontact_id必填

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.

輸入參數order_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.

無需輸入參數。

brightpearl_list_tax_codes

List tax codes

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

無需輸入參數。

版本歷史

16
  1. v1.19.4Nov 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

評分

已滿足適用檢查項的 100%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通必需25 分
  • 已宣告認證方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分

其他 Usefulapi 整合