Skip to main content
Perkstar exposes a Model Context Protocol server for conversational reporting. The connection is read-only: it can inspect loyalty data and analytics, but it cannot change customers, balances, cards, messages, or account settings.

​
Connection details

Add the server URL to a compatible MCP client. The client discovers Perkstar’s authorization, registration, token, and revocation endpoints automatically. The business owner or manager signs in, selects the organisation, and approves the read-only MCP scope.
A Perkstar API key cannot access MCP. Use the OAuth flow started by the MCP client; do not paste a dashboard API key into an AI application.

​
Available business tools

Programme and protection

Business overview, loyalty-card health, locations, and unusual-activity summaries.

Customers

Search customers, inspect a customer, view behavioural groups, and rank top customers.

Loyalty activity

Query stamps, points, redemptions, adjustments, and outstanding rewards.

Reporting

Performance, feedback, memberships, bookings, referrals, and broadcast reporting.
The server also provides guided prompts for a weekly performance review, win-back candidates, and card health checks. Tools return current Perkstar data; the AI client decides how to explain it.

​
Security model

  1. OAuth consent pins the token to one Perkstar organisation.
  2. The server checks the token scope, expiry, revocation, plan, and consenting user on every request.
  3. Tool schemas reject unknown fields and keep result sizes bounded.
  4. Requests appear in the organisation’s API activity log and follow its seven-day API audit retention.
  5. Revoking the connection invalidates the access and refresh token pair.
Perkstar staff tools can query across organisations, but they are exposed only when the consenting user independently passes the Perkstar staff check. A normal business connection cannot request or smuggle an organisation override.

​
Client compatibility

The server supports MCP protocol versions 2025-06-18, 2025-03-26, and 2024-11-05. It implements initialize, ping, tool listing and calls, and prompt listing and retrieval. It does not expose an SSE stream, resources, sampling, or write tools. For a bespoke application rather than an MCP client, use the marketplace OAuth guide and public REST API.

Related topics

Connect OdooPerkstar developer platformIntegration galleryChangelogBuild an OAuth marketplace app