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.
## Account
---
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
---
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)
---
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
---
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
---
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
---
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)
---
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
---
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?"*
Customer profile data may contain personal information. Ensure that your use of this tool complies with your organization's data privacy policies and applicable regulations.
## Loyalty
---
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
---
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_external`s` | 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
---
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.
{{< note >}}
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.
{{< /note >}}
| 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.
{{< note >}}
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.
{{< /note >}}
| 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.