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 集成