Skip to Content
Developers
MCP server

Tools

Every tool of the ENDVR MCP server, with its inputs and what it returns.

All tools are read-only and read the brand the grant is bound to. Each takes an optional brandId: any value other than the connected brand is refused before anything is read. Ids are 24-character hexadecimal strings.

Call get_brand_context first: the other tools default to its brand and currency.

get_brand_context

The connected brand: id, name, currency, language and the user's role on it.

No inputs besides brandId.

Returns brand (id, name, currency, language, yourRole, yourStoreScope, isRetailer, managesMultipleStores, serviceStatus, paymentPlan, hasLaunchedACampaign) and connection (one brand per connection).

get_performance_overview

The Brand Portal dashboard for a date range, from the synced reporting data.

Prop

Type

Returns totals (campaigns launched, rewards delivered, discount codes distributed with the change against the previous period, revenue opportunity, stores, store engagement, new active stores, new associates), campaignsLaunchedByType, rewardsDeliveredOverTime, newAssociatesOverTime, newActiveStoresList, the top and bottom 10 engaged stores, the top 20 associates, and unavailableCards when a figure couldn't be read. Series are grouped by day (up to 21 days), week (up to 90), month (up to 365) or year.

list_campaigns

Campaigns by portal tab, with the count of every tab.

Prop

Type

Returns countsByTab, totalCount, campaigns (id, name, type, status, isPaused, pauseReason, launchedAt, scheduledAt, endDate, finishedAt, stats, portalUrl) and nextCursor. stats (completions, participating associates, rewards paid) is filled for pages of 11 rows or fewer and never for drafts; its time is statsAsOf.

get_campaign

One campaign: status, dates, store scope, missions and rewards.

Prop

Type

Returns campaign with its missions (with completions for learning campaigns) and rewards (type, title, amount), plus the sections asked in include. Mission descriptions are clipped to 500 characters.

list_stores

Stores connected to the brand, pending or blocked, with the count per status.

Prop

Type

Returns countsByStatus, totalCount, stores (id, name, location, status, isActive, currency, connectedAt, associates, pendingAssociates, stats, portalUrl) and nextCursor. stats (associates, missions completed, sales, rewards paid) is filled for approved pages of 11 rows or fewer.

get_store

One store: status, address, associates with their results, totals and campaigns.

Prop

Type

Returns store (id, name, address, currency, status, associates, groups, stats), associates (names and roles, never contact details, with their missions, sales and rewards) and the store's campaigns (first page). A store that isn't connected to the brand returns an error asking to approve it.

get_wallet

The brand wallet and its latest transactions.

Prop

Type

Returns wallet (balance, pendingBalance, campaigns: deposited, earned and left) and transactions (id, type, amount, status, paymentMethod, createdAt, newest first) with nextCursor. Roles that can't see the wallet in the portal get an error.

On this page