Skip to main content

MCP features

The PartnerBoost MCP server exposes tools aligned with dashboard workflows. Tool names use a pb_ prefix.

What a connection gets is decided per merchant and per AI Access Key:

  • Read tools24 for most accounts, 25 if you are a Walmart or Amazon brand.
  • Write tools — up to 13, issued only when the key carries the matching scope. Amazon promo tools appear only for Amazon brands.

Existing connections keep the same URL and key. Reconnect (or toggle the connector off/on) so tools/list refreshes.

Read tools

Account & dashboard

ToolDescription
pb_get_merchant_contextAccount, plan, current user, and usage in one call
pb_get_dashboard_todoDashboard to-dos

Transactions

ToolDescription
pb_get_transaction_listPaginated order list (standard / multiplatform)
pb_get_transaction_statsAggregated metrics (sales, commission, counts)

Performance

ToolDescription
pb_get_performance_statsAccount-level performance summary (JSON, not charts)
pb_get_performance_listPerformance details plus period totals
pb_get_partner_performancePartner-level overview (totals + top 20)
pb_get_media_partner_performanceA single partner's performance

Billing & commissions

ToolDescription
pb_get_billing_overviewPaid billing plus pending prepayments
pb_get_commission_rulesCommission plan rules (CPS / Amazon / Walmart)

Partners & media

ToolDescription
pb_list_media_partnersExisting media partners
pb_get_publisher_overviewPublisher / influencer counts by status and group
pb_get_media_detailUnified media / influencer / partner detail (uid)
pb_find_mediaNatural-language search for publishers and influencers
pb_get_invited_partnersInvitation pipeline
pb_search_productsProduct catalog

Campaigns

ToolDescription
pb_get_campaign_listCampaign list
pb_get_campaign_overviewCampaign overview
pb_get_campaign_proposalsCampaign proposals / applications
pb_get_campaign_detailCampaign detail, content, and fulfillment

Messages & marketing

ToolDescription
pb_get_message_statsInbox statistics
pb_get_messagesIn-app messages and system notifications
pb_get_newsletter_overviewNewsletter overview
pb_get_coupon_tracking_listCoupon attribution

Write tools

Write tools let the assistant act on your account instead of only reading it. Grant them per key in AI Center → AI Connect → Manage AI Keys.

Every write tool takes the same envelope:

FieldRequiredNotes
actionYesThe operation to perform. Allowed values are listed in the tool's schema — do not invent values such as list or get.
idempotency_keyYesA string (UUID recommended). Replaying the same key on the same tool does not write twice. Reusing a key with different content returns a conflict error.
sub_actionNoOptional sub-operation within the tool. Unknown values return INVALID_SUB_ACTION.
dry_runNoWhen true, validate and preview only — nothing is persisted.
payloadNoBusiness fields for the chosen action. Prefer dry_run first.

Partners write

ToolDescription
pb_manage_partner_workspaceFollow / unfollow partners, manage invite templates and partner groups
pb_decide_partner_relationshipApprove or decline partner discovery relationships
pb_invite_or_message_partnersBulk invite or message partners

Catalog write

ToolDescription
pb_manage_productsProduct catalog and datafeed
pb_manage_creativesCreate, modify, delete, or batch-expire creatives
pb_manage_commission_rulesCreate, update, or sort special commission rules
pb_manage_amazon_promosAmazon promo codes and promotions (Amazon brands only)
pb_manage_growth_configCoupon tracking and ads budget

Outreach write

ToolDescription
pb_manage_newsletter_templatesNewsletter templates and groups
pb_send_newsletterSave, test, or send newsletters
pb_manage_recruitment_ppcRecruitment settings and PPC

Orders write

ToolDescription
pb_create_manual_orderCreate a manual affiliate order
pb_solve_order_inquiryResolve a transaction inquiry

Permissions

  • Read tools require the Read All scope on the key. Every key includes it.
  • Write tools additionally require the matching write scope: Partners write, Catalog write, Outreach write, or Orders write. Only the granted scopes appear in that key's tools/list.
  • A key created by the main account carries the full permissions of the account. A key created by a sub-account only gets the permissions granted to that sub-account.
  • Some actions also need a backend permission the brand account may not have — deleting creatives, for example, requires the Admin creative-delete permission. Those calls return Permission Not Found even though the tool is listed.
  • Every write call is logged, including denied ones.

Platform-specific

These appear only when your account is on that platform:

ToolAvailability
pb_get_walmart_wsrWalmart brands
pb_get_amazon_acc_overviewAmazon brands

Notes

  • Reconnect your MCP client after this update. Tool names start with pb_ and are not compatible with the previous names. The server URL and AI Access Key stay the same.
  • Publisher / influencer search can take tens of seconds to a few minutes. Wait for the reply rather than asking again.
  • Archived keys cannot be used for MCP calls.

For field-level IDs and date formats when you call tools yourself, see MCP FAQ.

Example prompts

  • "Show transaction stats for last month vs prior month."
  • "Who are my top 5 publishers by commission?"
  • "Search publishers in the beauty category."
  • "What's my current plan and usage?"
  • "Summarize paid and pending billing."
  • "Preview a commission rule for this publisher, then create it if it looks right."
  • "Draft a newsletter for my top 20 partners and show me the preview before sending."
API alternative

For automated pipelines without an LLM, use the Brand API or Partner API directly.