> Synerise Documentation — MCP
>
> This file contains the complete "MCP" section of the Synerise documentation. Each article begins with a top-level "# " heading. The manifest listing all sections is at https://hub.synerise.com/llms-full.txt
# Overview
This feature is available in [public preview](/docs/log-in-and-navigate-synerise-platform#public-preview) mode.
## What is MCP?
Model Context Protocol (MCP) is an open standard developed by Anthropic that defines how AI applications communicate with external tools and data sources. It works like a bridge: any MCP-compatible client can connect to an MCP server, which in turn provides access to tools, data, and documentation from a third-party system.
## What the Synerise MCP Server enables
The Synerise MCP Server is an implementation of the MCP standard for the Synerise platform. Once configured, you can connect any MCP-compatible client to your Synerise workspace (a chat assistant like Claude, a coding agent like Claude Code or Codex, or your own custom agent) and query analytics, inspect campaigns and workflows, retrieve customer profiles, explore AI models, browse loyalty programs, and access developer documentation, all in the flow of your work.
This removes the need to:
- Export data manually and paste it into your client
- Navigate through multiple Synerise screens to retrieve figures
- Search for documentation separately while working in your client
You get what you need from your workspace in real time, in the context of your request.
## What is available
The Synerise MCP Server covers the following product areas:
| Product area | What you can access |
|---|---|
| **Analytics** | Metrics, segmentations, funnels, trends, histograms, Sankey diagrams, reports, aggregates, expressions, including live calculation and profile segmentation membership checks |
| **Campaigns** | Campaign details, templates, in-app messages, landing pages, documents, screen views from the Experience Hub |
| **Automation** | Workflow details, schedules, statistics, execution history, upcoming triggers and status changes, workflows with issues, in-progress workflows, performance rankings, diagram notes, status counts, data transformations, block template catalogs |
| **AI Recommendations** | Recommendation campaigns, feed configurations, statistics, top product performance, live recommendation fetching and previewing |
| **AI Search** | Search indices, query rules, synonyms, query statistics, top queries, recent searches, live search query execution, autocomplete, and filter-only browsing |
| **AI (other)** | Predictions, AB tests, recommendation and search index listings |
| **CRM** | Customer profile lookup and contact search |
| **Loyalty** | Promotions and coupon pool details (personalized promotions are not accessible) |
| **Assets** | Catalogs, Brickworks schemas, records, and externals, code snippets, API keys, generate and preview Brickworks records |
| **Events** | Event action catalog and action parameters, per-profile event history lookup |
| **Account** | Current workspace identity and caller information |
| **Mobile SDK guidance** | iOS and Android SDK setup guides, configuration help, best practices, diagnostics, FAQ, integration validation |
| **VTEX guidance** | VTEX plugin setup, component guides, configuration help, integration validation |
For a full list of available operations, see [Available tools](/developers/mcp/available-tools).
## Example workflows
The following examples show how different team members can use the Synerise MCP Server to get more done in less time.
### Analyst: querying data without switching tools
An analyst wants to understand drop-off in the checkout funnel over the last 30 days. Instead of opening Synerise, building the funnel query, waiting for results, and then copying figures into a presentation, they ask directly:
> *Calculate the checkout funnel for the last 30 days. Show me the steps and where users drop off most.*
They get back a structured breakdown, including the step with the highest drop-off rate and a suggested hypothesis.
### Marketer: reviewing campaign status
A marketer preparing for a weekly review wants a summary of all active email campaigns:
> *List all active email campaigns and tell me which ones are scheduled to send in the next 7 days.*
They get the matching campaigns back with their scheduled send times, without opening the platform.
### Developer: setting up a mobile integration
A developer integrating Synerise into a new iOS app asks:
> *Walk me through setting up push notifications with the Synerise iOS SDK.*
They get a step-by-step walkthrough, built from the relevant Mobile SDK setup guide, configuration documentation, and best practices, tailored to their question.
### Operations: checking automation health
An operations manager wants to know if any workflows have issues before the weekend:
> *Are there any workflows currently failing or paused unexpectedly?*
They get automation status back immediately, including which workflows have issues and what kind of problem each one has, so the team can investigate before going offline.
## Who benefits
The Synerise MCP Server is useful for anyone who regularly works with Synerise data or needs to reference Synerise documentation:
- **Analysts and data teams** - run analytics queries in natural language, explore segmentations, and get results explained in context.
- **Marketers** - check campaign status, loyalty promotions, and recommendation performance without switching tools.
- **Developers** - get guided through SDK and VTEX integration steps, validate configurations, and troubleshoot issues.
- **Operations and automation teams** - monitor workflow health, check upcoming triggers, and investigate execution history.
## Data privacy and third party AI clients
The Synerise MCP Server operates within Synerise's infrastructure and is covered by your organization’s existing agreement with Synerise (including the applicable data processing agreement). Synerise provides the MCP Server as an integration interface and does not determine whether, how, or for what purpose you connect the Synerise MCP Server to any third-party AI client or AI agent, including Claude, Cursor, Windsurf, or VS Code with Copilot.
If you choose to connect the Synerise MCP Server to a third-party AI client/AI agent, any data the server retrieves - including personal data such as customer profiles, contact details, or event history – may be transmitted to and processed by that AI provider in order to generate a response. Such processing is performed outside Synerise's infrastructure and outside Synerise's control. All terms applicable to that processing are determined by the provider of the relevant AI client or AI agent and by your configuration and use of that AI client/AI agent.
By connecting any third-party AI client or AI agent to the Synerise MCP Server, you remain solely responsible for assessing, authorizing, configuring, and monitoring that connection. Synerise does not verify or approve third-party AI clients/AI agents connected by you and does not control the prompts, instructions, outputs, or downstream processing performed by those tools.
Before connecting the Synerise MCP Server to any third-party AI client or AI agent, confirm that:
- your organization permits the use of it and has identified a valid legal basis for that use, including, where required, an appropriate data processing agreement and other contractual arrangements with the relevant AI provider.
- the intended use case complies with applicable data protection, confidentiality, sector-specific, and AI-related legal requirements, including any restrictions on international data transfers.
- the Synerise account used to authenticate has only the permissions necessary for the intended use case, to limit the personal data and other confidential information that can be accessed and transmitted to the connected AI client or AI agent.
Read-only access limits what the Synerise MCP Server can change in your workspace; it does not limit the scope of data, including personal data, that can be read, retrieved, included in prompts or context, and transmitted to the connected AI client or AI agent.
Synerise is not responsible for processing performed by third-party AI clients or AI agents selected, connected, configured, or used by you, including any use of data by those providers, any retention or deletion practices, any model-training or model-improvement use, any generated outputs, or any decisions or actions taken on the basis of those outputs.
## Limitations
- **Read-only access** - the MCP server can retrieve and calculate data, but cannot create, update, or delete anything in your workspace.
- **Workspace scope** - the server connects to a single workspace at a time, determined by the API key you configure.
- **No real-time event streaming** - the server retrieves data on demand in response to each question; it does not push live updates or subscribe to workspace events.
- **Client behavior** - the accuracy and usefulness of responses depends on how your client interprets your request and selects tools. Complex or ambiguous requests may require follow-up clarification.
## What's next
Proceed to [Getting started](/developers/mcp/getting-started) to configure the Synerise MCP Server with your client.
# Getting started
This feature is available in [public preview](/docs/log-in-and-navigate-synerise-platform#public-preview) mode.
This page explains how to connect the Synerise MCP Server. The setup takes a few minutes and does not require writing any code.
## Prerequisites
---
Before you start, make sure you have a **Synerise account** with access to the workspace you want to connect, and read permissions for the product areas you want your client to access. For example, without analytics permissions, analytics tools will return an authorization error when called.
## Configuration
---
The following example shows how to connect the Synerise MCP Server to Claude Code.
### One-time setup
Add the server using the Claude Code CLI:
```bash
claude mcp add -s user --transport http synerise-ai
```
Replace `` with the API URL for the data center where your workspace is hosted. See [Regional endpoints](#regional-endpoints) for the full list.
Then, in a Claude Code session, run:
```bash
/mcp
```
This starts the login flow and lets you select which Synerise workspace to connect.
The token is workspace-scoped; you choose the workspace when you log in. To switch workspaces, run `/mcp` again and log in with a different workspace.
After adding the server, restart Claude Code so the new tools load.
### Troubleshooting
- **Server not listed as connected** - run `claude mcp list` and confirm `synerise-ai` shows as `✓ Connected`.
- **"Authentication required" when calling a tool** - run `/mcp` and log in again.
- **Tools not showing up** - restart Claude Code.
- **Token expired** - run `/mcp` and re-authenticate.
## Verifying the connection
---
After the server is connected, you can verify it by asking:
> *What Synerise workspace am I connected to?*
Your client calls the `account_whoami` tool and returns your workspace name and the identity of the Synerise account you logged in with. If the server is not connected, your client will not be able to answer and will indicate that the tool is unavailable.
## Regional endpoints
---
The MCP endpoint depends on the data center where your workspace is hosted:
| Hosting | MCP endpoint |
|---|---|
| Azure EU | `https://api.synerise.com/mcp` |
| Google Cloud Platform | `https://api.geb.synerise.com/mcp` |
| Azure US | `https://api.azu.synerise.com/mcp` |
If you are not sure which data center your workspace uses, check the URL to which you log to the Synerise application.
## Permissions and data access
---
The Synerise MCP Server acts on your behalf using the [permissions of the Synerise account](/docs/settings/identity-access-management/permissions#which-permissions-do-i-need) you log in with. All operations are **read-only**: the server can retrieve, list, and calculate, but it cannot create, update, or delete any data in your workspace.
If your account does not have access to a particular resource (for example, loyalty promotions or CRM contacts), your client will receive an authorization error when it tries to retrieve that data and will inform you accordingly.
Depending on your permissions, tool results may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
## Troubleshooting
---
**Your client says the Synerise tools are not available**
The MCP server is not connected. Check the following:
- Confirm you added the server correctly and fully restarted your client after adding it.
- Run the login command again (for example, `/mcp` in Claude Code) to check the connection status and re-authenticate if needed.
- Open your client's MCP log or developer console to see if the connection failed.
**Your client says authentication is required**
Your login session has expired or was never completed. Re-run the login command (for example, `/mcp` in Claude Code) and log in again.
**Your client receives a 403 Forbidden error**
Your Synerise account does not have permission to access the requested resource. Check your account's permissions in the Synerise application and make sure you have read access to the relevant product area.
**Your client is connected to the wrong workspace**
The token is workspace-scoped, chosen when you log in. Log in again and select the correct workspace.
**The server starts but returns no data**
Confirm that the workspace you are connected to contains the data you are asking about. For example, if you ask for recommendation campaigns and none exist, the tool returns an empty result; this is expected behavior, not an error.
## What's next
---
Once your connection is verified, you can start using the Synerise MCP Server straight away: just ask your client questions about your workspace and it will use the available tools automatically. If you want to know what tools are available and what each one does, see [Available tools](/developers/mcp/available-tools).
# Available tools
This feature is available in [public preview](/docs/log-in-and-navigate-synerise-platform#public-preview) mode.
The Synerise MCP Server exposes tools organized by product area. Each tool can be called by the AI assistant when you ask a question that requires data from your workspace. You do not call tools directly: the assistant selects and calls the appropriate tool based on your request.
The following sections describe all available tools grouped by area. All tools are read-only.
Tool results may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
## Account
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for retrieving the identity of the current workspace and API caller.
| Tool | Description |
|---|---|
| `account_whoami` | Returns the name of the connected workspace and the identity of the caller associated with the configured API key. |
**Example prompt:** *"What workspace am I connected to?"*
## Analytics
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for retrieving, previewing, and calculating analytics data from your workspace, including [metrics](/docs/analytics/metrics), [segmentations](/docs/analytics/segmentations), [funnels](/docs/analytics/funnels), [trends](/docs/analytics/trends), [histograms](/docs/analytics/histograms), [Sankey diagrams](/docs/analytics/sankey-charts), [reports](/docs/analytics/reports), [aggregates](/docs/crm/aggregates), and [expressions](/docs/crm/expressions). Also supports checking which segmentations a profile belongs to.
Each analytics type has three tool variants:
- `list`: retrieves a list of saved analyses of that type.
- `get`: retrieves the configuration of a specific saved analysis.
- `calculate` / `preview`: runs the analysis and returns results.
| Tool | Description |
|---|---|
| `analytics_list_metrics` | Lists saved metric definitions. |
| `analytics_get_metric` | Retrieves configuration of a specific metric. |
| `analytics_calculate_metric` | Calculates and returns metric results. |
| `analytics_preview_metric` | Returns a preview of metric results. |
| `analytics_list_segmentations` | Lists saved segmentations. |
| `analytics_get_segmentation` | Retrieves configuration of a specific segmentation. |
| `analytics_preview_segmentation` | Runs a segmentation and returns a profile count preview. |
| `analytics_check_segmentations` | Validates segmentation conditions. |
| `analytics_list_funnels` | Lists saved funnel analyses. |
| `analytics_get_funnel` | Retrieves configuration of a specific funnel. |
| `analytics_calculate_funnel` | Calculates funnel results including step conversion rates. |
| `analytics_preview_funnel` | Returns a preview of funnel results. |
| `analytics_list_trends` | Lists saved trend analyses. |
| `analytics_get_trend` | Retrieves configuration of a specific trend. |
| `analytics_calculate_trend` | Calculates trend results over a time range. |
| `analytics_preview_trend` | Returns a preview of trend results. |
| `analytics_list_histograms` | Lists saved histograms. |
| `analytics_get_histogram` | Retrieves configuration of a specific histogram. |
| `analytics_calculate_histogram` | Calculates histogram results. |
| `analytics_preview_histogram` | Returns a preview of histogram results. |
| `analytics_list_sankeys` | Lists saved Sankey diagram analyses. |
| `analytics_get_sankey` | Retrieves configuration of a specific Sankey diagram. |
| `analytics_preview_sankey` | Returns a preview of Sankey diagram results. |
| `analytics_list_reports` | Lists saved reports. |
| `analytics_get_report` | Retrieves configuration of a specific report. |
| `analytics_calculate_report` | Calculates and returns report results. |
| `analytics_preview_report` | Returns a preview of report results. |
| `analytics_list_aggregates` | Lists saved aggregate analyses. |
| `analytics_get_aggregate` | Retrieves configuration of a specific aggregate. |
| `analytics_calculate_aggregate` | Calculates aggregate results. |
| `analytics_preview_aggregate` | Returns a preview of aggregate results. |
| `analytics_list_expressions` | Lists saved expression analyses. |
| `analytics_get_expression` | Retrieves configuration of a specific expression. |
| `analytics_calculate_expression` | Calculates expression results. |
| `analytics_preview_expression` | Returns a preview of expression results. |
| `analytics_get_analytics_api_schema` | Returns the API schema for analytics request structures. |
| `analytics_get_analytics_docs` | Returns analytics documentation for reference. |
**Example prompts:**
- *"Calculate the checkout funnel for the last 30 days."*
- *"What are the top 5 events by frequency in this week's trend analysis?"*
- *"List all saved metrics in my workspace."*
## Campaigns (Experience Hub)
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for retrieving campaigns and related Experience Hub content, including documents, in-app messages, landing pages, screen views, and templates. All tools are read-only.
| Tool | Description |
|---|---|
| `campaigns_list_campaigns` | Lists communication campaigns, filterable by channel. |
| `campaigns_get_campaign` | Retrieves details of a specific campaign. |
| `campaigns_list_templates` | Lists available campaign templates. |
| `campaigns_get_template` | Retrieves a specific template. |
| `campaigns_list_documents` | Lists [documents](/docs/assets/documents). |
| `campaigns_get_document` | Retrieves a specific document. |
| `campaigns_list_in_app_messages` | Lists [in-app message campaigns](/docs/campaign/in-app-messages). |
| `campaigns_get_in_app_message` | Retrieves details of a specific in-app message. |
| `campaigns_list_landing_pages` | Lists [landing page campaigns](/docs/campaign/landing-page). |
| `campaigns_get_landing_page` | Retrieves details of a specific landing page. |
| `campaigns_list_screen_views` | Lists [screen view](/docs/campaign/screen-views) configurations. |
| `campaigns_get_screen_view` | Retrieves details of a specific screen view. |
**Example prompts:**
- *"List all active email campaigns."*
- *"Show me the details of the campaign named 'Summer Sale'."*
- *"Which in-app messages are currently running?"*
## Automation
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for inspecting automation diagrams and their execution state, including health, scheduling, and performance. Also covers data transformations and block template catalogs. All tools are read-only.
In the Synerise platform, these are called [workflows](/glossary#workflow). The MCP tool names use `automation` and `diagram` as technical identifiers, for example, `automation_list_diagrams` lists your workflows.
| Tool | Description |
|---|---|
| `automation_list_diagrams` | Lists workflows. |
| `automation_get_diagram` | Retrieves the full configuration of a specific workflow. |
| `automation_get_diagram_notes` | Retrieves notes attached to [nodes](/glossary#node) in a workflow. |
| `automation_get_diagram_schedule` | Retrieves the schedule configuration of a workflow. |
| `automation_get_diagram_statistics` | Returns execution statistics for a workflow. |
| `automation_get_block_statistics` | Returns statistics for a specific node within a workflow. |
| `automation_list_diagram_executed_events` | Lists events that have triggered a workflow. |
| `automation_list_diagram_upcoming_events` | Lists events scheduled to trigger a workflow. |
| `automation_list_diagram_upcoming_status_changes` | Lists scheduled status changes for a workflow. |
| `automation_list_diagrams_with_issues` | Lists workflows currently in an error or degraded state. |
| `automation_list_in_progress_diagrams` | Lists workflows that are currently executing. |
| `automation_list_most_triggered_diagrams` | Lists workflows sorted by trigger frequency. |
| `automation_list_most_used_diagrams` | Lists workflows sorted by usage. |
| `automation_list_upcoming_triggers` | Lists all upcoming trigger events across workflows. |
| `automation_list_upcoming_status_changes` | Lists all scheduled status changes across workflows. |
| `automation_count_diagrams_by_status` | Returns a count of workflows grouped by status. |
| `automation_count_diagrams_by_trigger_type` | Returns a count of workflows grouped by trigger type. |
| `automation_list_catalogs` | Lists node template catalogs. |
| `automation_list_block_template_catalogs` | Lists catalogs of reusable node templates. |
| `automation_list_data_transformations` | Lists available [data transformation](/docs/automation/data-transformation-and-imports/introduction) configurations. |
| `automation_get_data_transformation` | Retrieves details of a specific data transformation. |
**Example prompts:**
- *"Are there any workflows with issues right now?"*
- *"Which workflows are scheduled to run tomorrow?"*
- *"Show me the execution statistics for the 'Post-purchase follow-up' workflow."*
## AI Recommendations
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for exploring [AI recommendation campaigns](/docs/ai-hub/recommendations-v2), feed configurations, and performance statistics, as well as fetching and previewing live recommendation results.
| Tool | Description |
|---|---|
| `reco_list_campaigns` | Lists all AI recommendation campaigns. |
| `reco_list_campaigns_summary` | Lists AI recommendation campaigns with a lightweight summary. |
| `reco_get_campaign` | Retrieves full configuration of a specific AI recommendation campaign. |
| `reco_get_feed_config` | Retrieves the feed configuration for an AI recommendation campaign. |
| `reco_get_recommendations` | Retrieves recommended items for a given context. |
| `reco_preview_recommendations` | Returns a preview of recommended items. |
| `reco_get_reco_stats` | Returns performance statistics for an AI recommendation campaign. |
| `reco_get_top_products_stats` | Returns statistics for the top-performing products. |
| `reco_get_recommendations_docs` | Returns documentation for the Recommendations API. |
**Example prompts:**
- *"List all active recommendation campaigns."*
- *"What are the top recommended products for an anonymous user on the homepage?"*
- *"Show me the performance statistics for the 'Similar products' campaign."*
## AI Search
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for exploring [search indices](/docs/ai-hub/ai-search/create-index), [query rules](/docs/ai-hub/ai-search/query-rules), [synonyms](/docs/ai-hub/ai-search/add-synonyms), and query analytics as well as executing live search queries and autocomplete requests.
| Tool | Description |
|---|---|
| `search_list_indices` | Lists all search indices. |
| `search_list` | Returns a summarized list of search configurations. |
| `search_get_index_config` | Retrieves the configuration of a specific search index. |
| `search_list_suggestion_indices` | Lists autocomplete/suggestion indices. |
| `search_query` | Executes a search query against an index and returns results. |
| `search_autocomplete` | Returns autocomplete suggestions for a partial query. |
| `search_list_query_rules` | Lists query rules for a search index. |
| `search_get_query_rule` | Retrieves details of a specific query rule. |
| `search_list_synonyms` | Lists synonym configurations for a search index. |
| `search_get_top_queries` | Returns the most frequent search queries. |
| `search_list_recent_searches` | Lists recently executed search queries. |
| `search_get_query_stats_summary` | Returns an aggregated summary of query statistics. |
| `search_get_search_docs` | Returns documentation for the Search API. |
**Example prompts:**
- *"What are the top 10 search queries in my store this week?"*
- *"List all query rules for the 'products' search index."*
- *"Run a search for 'running shoes' and show me the top results."*
## AI (Predictions, AB Tests)
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for a lightweight exploration of AI models, including [predictions](/docs/ai-hub/predictions), [AB tests](/docs/ai-hub/recommendations-v2/recommendation-abx-test), and [recommendation](/docs/ai-hub/recommendations-v2) and [search index](/docs/ai-hub/ai-search) listings.
| Tool | Description |
|---|---|
| `ai_list_predictions` | Lists available prediction models. |
| `ai_get_prediction` | Retrieves details of a specific prediction model. |
| `ai_list_abtests` | Lists AI AB tests. |
| `ai_get_abtest` | Retrieves details of a specific AB test. |
| `ai_list_recommendations` | Lists recommendation models (lightweight). |
| `ai_get_recommendation` | Retrieves details of a specific recommendation model. |
| `ai_list_search_indices` | Lists search index models (lightweight). |
| `ai_get_search_index` | Retrieves details of a specific search index model. |
**Example prompts:**
- *"What prediction models are available in my workspace?"*
- *"Show me the details of the AB test named 'Homepage reco test'."*
## CRM
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for looking up customer [profiles](/docs/crm/crm-profile) in your workspace.
| Tool | Description |
|---|---|
| `crm_list_contacts` | Searches for and lists customer profiles. |
| `crm_get_contact` | Retrieves details of a specific customer profile. |
**Example prompts:**
- *"Find the profile for the customer with email address jan@example.com."*
- *"How many attributes does customer profile 12345 have?"*
## Loyalty
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for exploring loyalty [promotions](/docs/ai-hub/promotions) and [voucher pools](/docs/assets/code-pools).
| Tool | Description |
|---|---|
| `loyalty_list_promotions` | Lists promotions. |
| `loyalty_get_promotion` | Retrieves details of a specific promotion. |
| `loyalty_list_coupons` | Lists voucher pools (voucher collections). |
| `loyalty_get_coupon` | Retrieves details of a specific voucher pool. |
**Example prompts:**
- *"List all active promotions."*
- *"What are the terms of the 'VIP Summer Discount' promotion?"*
## Assets
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for exploring assets in your workspace, including [catalogs](/docs/assets/catalogs), [Brickworks](/docs/assets/brickworks) schemas, records, and externals, [code snippets](/docs/assets/snippets), and [API keys](/docs/settings/tool/api). Also supports generating and previewing Brickworks records.
| Tool | Description |
|---|---|
| `assets_list_catalogs` | Lists item catalogs. |
| `assets_get_catalog` | Retrieves details of a specific catalog. |
| `assets_list_snippets` | Lists code snippets. |
| `assets_get_snippet` | Retrieves the content of a specific snippet. |
| `assets_list_brickworks_schemas` | Lists Brickworks block schemas. |
| `assets_get_brickworks_schema` | Retrieves a specific Brickworks block schema. |
| `assets_list_brickworks_records` | Lists Brickworks records. |
| `assets_get_brickworks_record` | Retrieves a specific Brickworks record. |
| `assets_list_brickworks_externals` | Lists Brickworks external integrations. |
| `assets_get_brickworks_external` | Retrieves details of a specific Brickworks external integration. |
| `assets_generate_brickworks_record` | Renders an existing stored record by resolving Jinjava inserts and external-source requests for a given profile. |
| `assets_preview_brickworks_record` | Renders ad-hoc field values against a schema definition without requiring a stored record. |
| `assets_list_apikeys` | Lists API keys available in the workspace. |
| `assets_get_apikey` | Retrieves details of a specific API key. |
**Example prompts:**
- *"List all item catalogs in my workspace."*
- *"What does the 'product-card' Brickworks schema look like?"*
## Events
---
Results of this tool may include personal data or other sensitive information. See [Data privacy and third-party AI clients](/developers/mcp/overview#data-privacy-and-third-party-ai-clients) before connecting a client.
Tools for exploring the [event](/docs/assets/events) schema catalog (available event types and the parameters each accepts) and querying per-profile event history (browsing and inspecting recorded events for a specific customer).
| Tool | Description |
|---|---|
| `events_list_actions` | Lists available events tracked in the workspace. |
| `events_list_action_parameters` | Lists parameters defined for a specific event. |
| `events_list_profile_events` | Returns the full event history for a single profile. |
| `events_get_profile_event` | Fetches the full detail of a single event for a profile |
**Example prompts:**
- *"What events are available in my workspace?"*
- *"What parameters does the 'product.addToCart' event accept?"*
## Mobile SDK guidance
---
These tools provide structured guidance for implementing and troubleshooting the [Synerise Mobile SDK](/developers/mobile-sdk) (iOS and Android). They retrieve documentation, setup guides, best practices, FAQs, and diagnostic information, and support integration validation - all from Synerise's internal knowledge base.
Unlike the data tools in other sections, Mobile SDK guidance tools do not query your workspace. They retrieve information from Synerise's built-in documentation and return it as guidance within your conversation.
| Tool | Description |
|---|---|
| `mobile_get_sdk_setup_guide` | Returns a setup guide for iOS or Android SDK integration. |
| `mobile_get_mobile_sdk_docs` | Returns Mobile SDK documentation for a specified topic. |
| `mobile_get_sdk_feature_guide` | Returns a guide for a specific SDK feature. |
| `mobile_get_sdk_configuration_help` | Returns configuration instructions for a given SDK scenario. |
| `mobile_get_sdk_best_practices` | Returns best practices for SDK integration. |
| `mobile_get_sdk_faq` | Returns frequently asked questions and answers. |
| `mobile_validate_integration` | Validates a described integration scenario and highlights potential issues. |
| `mobile_diagnose_sdk_issue` | Diagnoses a described SDK issue and suggests resolution steps. |
**Example prompts:**
- *"Walk me through setting up push notifications in the Synerise iOS SDK."*
- *"What are the best practices for user identification in the Android SDK?"*
- *"I'm getting a 401 error when initializing the SDK. What should I check?"*
## VTEX guidance
---
These tools provide structured guidance for integrating and configuring the [Synerise VTEX plugin](/docs/settings/tool/vtex/vtex-integration). They retrieve documentation, setup instructions, component guides, and validation information.
Unlike the data tools in other sections, VTEX guidance tools do not query your workspace. They retrieve information from Synerise's built-in documentation and return it as guidance within your conversation.
| Tool | Description |
|---|---|
| `vtex_get_setup_guide` | Returns a setup guide for the Synerise VTEX plugin. |
| `vtex_get_docs` | Returns general VTEX plugin documentation. |
| `vtex_get_feature_guide` | Returns a guide for a specific VTEX feature. |
| `vtex_get_component_guide` | Returns documentation for a specific VTEX component. |
| `vtex_get_configuration_help` | Returns configuration instructions for a VTEX scenario. |
| `vtex_get_best_practices` | Returns best practices for VTEX plugin integration, common mistakes and key symptoms |
| `vtex_validate_integration` | Validates a described VTEX integration scenario. |
| `vtex_diagnose_issue` | Diagnoses a described VTEX issue and suggests resolution steps. |
**Example prompts:**
- *"How do I configure the Synerise recommendation widget in my VTEX storefront?"*
- *"Walk me through the initial VTEX plugin setup."*
- *"The Synerise tracker isn't firing on VTEX. How do I diagnose this?"*
---
## What's next
Return to the [Overview](/developers/mcp/overview) to revisit what the Synerise MCP Server enables, or go to [Getting started](/developers/mcp/getting-started) if you have not yet configured your AI client.
# Synerise MCP Server
This feature is available in [public preview](/docs/log-in-and-navigate-synerise-platform#public-preview) mode.
The Synerise MCP Server lets AI assistants such as Claude connect directly to your Synerise workspace. Instead of switching between your AI tool and the Synerise platform, you can query analytics, explore campaigns, check automation status, and access documentation, all from within a single conversation.
This section covers what the MCP server is, how to set it up, and what tools it exposes.
---
- [Overview](/developers/mcp/overview): What MCP is, what the Synerise MCP Server enables, and who benefits from it
- [Getting started](/developers/mcp/getting-started): Prerequisites, installation, and client configuration
- [Available tools](/developers/mcp/available-tools): Full reference of all tools organized by product area