Developers

Available tools

IMPORTANT: This feature is available in public preview mode.

The Synerise MCP Server exposes tools organized by product area. Each tool can be called by the AI client when you ask a question about your workspace or ask it to make changes in your workspace. You do not call tools directly: the AI client selects and calls the appropriate tool based on your request.

The following sections describe all available tools grouped by area. Tools that create or change data (for example, create, update, set, duplicate) are available only when Write is enabled in the Synerise MCP Server settings. The AI client never exceeds the permissions of the user it acts for.

Account

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for retrieving the ID and name of the workspace you are connected to.

Tool Description
account_whoami Returns the ID and the name of the connected workspace.

Example prompt: "What workspace am I connected to?"

Analytics

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for retrieving, previewing, and calculating analytics data from your workspace, including metrics, segmentations, funnels, trends, histograms, Sankey diagrams, reports, aggregates, and expressions. Also supports checking which segmentations a profile belongs to. You can also create and update saved analyses, and manage dashboards, their widgets, sharing, and folders.

Analytics tools come in the following variants. Not every analytics type has all of them. For example, segmentations and Sankey diagrams have no calculate tool.

  • list: retrieves a list of saved analyses of that type.
  • get: retrieves the configuration of a specific saved analysis.
  • calculate: calculates a saved analysis, optionally with temporary changes to dates, filters, or variables.
  • preview: calculates an analysis from a definition provided in the request, without saving it.
  • create: saves a new analysis.
  • update: overwrites a saved analysis.
Tool Description
analytics_list_metrics Lists saved metric definitions.
analytics_get_metric Retrieves configuration of a specific metric.
analytics_calculate_metric Calculates a saved analysis with optional temporary changes to dates, filters, or variables.
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 Checks whether a profile belongs to the given segmentations (up to 10).
analytics_list_funnels Lists saved funnel analyses.
analytics_get_funnel Retrieves configuration of a specific funnel.
analytics_calculate_funnel Calculates a saved analysis with optional temporary changes to dates, filters, or variables.
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 a saved analysis with optional temporary changes to dates, filters, or variables.
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 a saved analysis with optional temporary changes to dates, filters, or variables.
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 a saved analysis with optional temporary changes to dates, filters, or variables.
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 a saved analysis with optional temporary changes to dates, filters, or variables.
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 a saved analysis with optional temporary changes to dates, filters, or variables.
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 built-in reference guides on Analytics.
analytics_create_aggregate Saves a new aggregate.
analytics_create_expression Saves a new expression.
analytics_create_funnel Saves a new funnel.
analytics_create_histogram Saves a new histogram.
analytics_create_metric Saves a new metric.
analytics_create_report Saves a new report.
analytics_create_sankey Saves a new Sankey diagram.
analytics_create_segmentation Saves a new segmentation.
analytics_create_trend Saves a new trend.
analytics_update_aggregate Overwrites a saved aggregate. Full replace: omitted fields are cleared.
analytics_update_expression Overwrites a saved expression. Full replace: omitted fields are cleared.
analytics_update_funnel Overwrites a saved funnel. Full replace: omitted fields are cleared.
analytics_update_histogram Overwrites a saved histogram. Full replace: omitted fields are cleared.
analytics_update_metric Overwrites a saved metric. Full replace: omitted fields are cleared.
analytics_update_report Overwrites a saved report. Full replace: omitted fields are cleared.
analytics_update_sankey Overwrites a saved Sankey diagram. Full replace: omitted fields are cleared.
analytics_update_segmentation Overwrites a saved segmentation. Full replace: omitted fields are cleared.
analytics_update_trend Overwrites a saved trend. Full replace: omitted fields are cleared.
analytics_list_dashboards Lists dashboards the user can see.
analytics_get_dashboard Retrieves a dashboard's settings and widgets.
analytics_get_dashboard_dependencies Lists the analyses and files a dashboard uses, and the events and profile attributes its dashboard filter references.
analytics_create_dashboard Creates a dashboard from a list of widgets.
analytics_duplicate_dashboard Copies a dashboard with its widgets.
analytics_add_dashboard_widgets Adds widgets to an existing dashboard.
analytics_update_dashboard_widget Changes a single dashboard widget. Only the fields provided are changed; others keep their current values.
analytics_update_dashboard_settings Changes a dashboard's name, privacy, filter, date range, or variables.
analytics_get_dashboard_sharing Lists users a dashboard is shared with and their access level.
analytics_share_dashboard Sets who a dashboard is shared with. Replaces the whole sharing list.
analytics_list_directories Lists folders for dashboards or a given analysis type.
analytics_move_dashboard_to_directory Moves a dashboard to another folder.

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."
  • "Create a dashboard with the checkout funnel and the weekly revenue trend."

Campaigns (Experience Hub)

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for retrieving campaigns and related Experience Hub content, including documents, in-app messages, landing pages, screen views, and templates. You can also create and configure documents and screen views, including their content, audience, schedule, priority, and status, and manage their folders.

Tool Description
campaigns_list_campaigns Lists communication campaigns of one channel: email, SMS, web push, mobile push, or Dynamic Content.
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.
campaigns_get_document Retrieves a specific document.
campaigns_list_in_app_messages Lists in-app message campaigns.
campaigns_get_in_app_message Retrieves details of a specific in-app message.
campaigns_list_landing_pages Lists landing page campaigns.
campaigns_get_landing_page Retrieves a specific version of a landing page.
campaigns_list_screen_views Lists screen view configurations.
campaigns_get_screen_view Retrieves details of a specific screen view.
campaigns_create_document Creates an empty document in draft.
campaigns_set_document_content Sets a document's content, slug, schema, and priority. Full replace: omitted fields are cleared. The slug can't be changed once set.
campaigns_preview_document Renders document content for a profile without saving it.
campaigns_create_screen_view Creates an empty screen view in draft.
campaigns_set_screen_view_content Sets what a screen view serves: its template, documents, and groups. Full replace: omitted fields are cleared. Don't use it on screen views that serve an ordered list of documents or Brickworks records, because saving deletes that list.
campaigns_set_screen_view_feed Assigns a screen view to a feed.
campaigns_rename_content_object Renames a screen view or document.
campaigns_set_content_object_audience Sets the audience of a screen view or document. Full replace: omitted fields are cleared.
campaigns_set_content_object_priority Sets the priority of a screen view or document, from 0 (highest) to 99 (lowest, the default). For screen views, the one with the highest priority is shown when several match the same feed. For documents, priority sets the order in which a group's documents are returned.
campaigns_set_content_object_schedule Saves the schedule of a screen view or document.
campaigns_get_content_object_schedule Retrieves the schedule of a screen view or document.
campaigns_set_content_object_status Activates, pauses, resumes, or finishes a screen view or document, or returns a finished document to draft.
campaigns_get_content_object_relations Shows where a screen view or document is used, or what it references.
campaigns_get_content_object_editor_settings Shows which steps of the screen view or document editor are marked as completed or skipped. Doesn't affect how the content is delivered.
campaigns_set_content_object_editor_settings Marks steps of the screen view or document editor as completed or skipped, so the editor shows the correct progress. Doesn't affect how the content is delivered. Full replace: omitted fields are cleared.
campaigns_list_content_directories Lists folders for screen views or documents.
campaigns_create_content_directory Creates a folder for screen views or documents.

Example prompts:

  • "List all active email campaigns."
  • "Show me the details of the campaign named 'Summer Sale'."
  • "Which in-app messages are currently running?"
  • "Create a draft screen view for the homepage banner and schedule it for next week."

Automation

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for inspecting workflows and their execution state, including health, scheduling, and performance. Also covers data transformations and the folders that workflows and node templates are organized into.

NOTE: In the Synerise platform, these are called workflows. 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 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 past scheduled runs of a workflow in a time range.
automation_list_diagram_upcoming_events Lists upcoming scheduled runs of a workflow in a time range.
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 the folders that workflows are organized into.
automation_list_block_template_catalogs Lists the folders that saved node templates are organized into.
automation_list_data_transformations Lists available data transformation 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

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for exploring AI recommendation campaigns, AI Engine configurations, and performance statistics, as well as fetching and previewing live recommendation results. You can also create, update, copy, and change the state of AI recommendation campaigns, configure the AI Engine for a catalog, and manage campaign folders.

Tool Description
reco_list_campaigns Lists all AI recommendation campaigns.
reco_list_campaigns_summary Lists all AI recommendation campaigns with only their ID, title, and type. Can be filtered by campaign type and state.
reco_get_campaign Retrieves full configuration of a specific AI recommendation campaign.
reco_get_feed_config Retrieves the AI Engine configuration and model states for an item catalog.
reco_get_recommendations Retrieves recommended items for a given context.
reco_preview_recommendations Returns a preview of recommended items.
reco_get_reco_stats Returns AI recommendation statistics for the workspace, selected campaigns, or one campaign.
reco_get_top_products_stats Returns the top 10 products in an AI recommendation campaign, ranked by a chosen metric.
reco_get_recommendations_docs Returns built-in reference guides on AI Recommendations: campaign types, slots, filtering, boosting, and campaign management.
reco_create_campaign Creates an AI recommendation campaign.
reco_update_campaign Overwrites an AI recommendation campaign. Full replace: omitted fields are cleared.
reco_copy_campaign Creates a draft copy of an AI recommendation campaign.
reco_copy_campaign_config Copies one campaign's configuration into another existing campaign.
reco_set_campaigns_state Changes the state (draft, active, paused) of up to 10 campaigns.
reco_create_feed_config Creates the AI Engine configuration for a catalog, using default values. If the catalog already has an AI Engine configuration, it's reset to the defaults.
reco_update_feed_config Updates selected fields of a catalog's AI Engine configuration.
reco_create_campaign_directory Creates a folder for AI recommendation campaigns.
reco_rename_campaign_directory Renames an AI recommendation campaign folder.
reco_attach_campaigns_to_directory Moves AI recommendation campaigns into a folder.

Example prompts:

  • "List all active AI 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."
  • "Make a draft copy of the 'Similar products' campaign."

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for exploring AI search indices, query rules, synonyms, and query analytics as well as executing live search queries and autocomplete requests. You can also create and configure AI search indices, suggestion indices, query rules, and synonyms, and manage their folders.

Tool Description
search_list_indices Lists all AI search indices.
search_list Browses items in an index using filters only, without a text query.
search_get_index_config Retrieves the configuration of a specific AI search index.
search_list_suggestion_indices Lists autocomplete/suggestion indices.
search_query Executes a search query against an AI search index and returns results.
search_autocomplete Returns autocomplete suggestions for a partial query.
search_list_query_rules Lists query rules for an AI search index.
search_get_query_rule Retrieves details of a specific query rule.
search_list_synonyms Lists synonym configurations for an AI search index.
search_get_top_queries Returns up to 1000 top search queries, ranked by count, clicks, CTR, conversions, conversion rate, or revenue.
search_list_recent_searches Lists a profile's recent search queries on an index.
search_get_query_stats_summary Returns an aggregated summary of query statistics.
search_get_search_docs Returns built-in reference guides on AI Search: query endpoints, indices, query rules, synonyms, and search management.
search_create_index Creates an AI search index.
search_update_index_config Overwrites an AI search index's configuration. Full replace: omitted fields are cleared.
search_duplicate_index Creates a copy of an AI search index under a new ID.
search_copy_index_config Copies one index's configuration into another index, overwriting it.
search_set_catalog_search_state Enables or disables AI Search for an item catalog.
search_create_suggestion_index Creates a suggestion index.
search_update_suggestion_index_config Overwrites a suggestion index's configuration. Full replace: omitted fields are cleared.
search_create_query_rule Creates a query rule in draft.
search_update_query_rule Overwrites a query rule. Full replace: omitted fields are cleared.
search_set_query_rule_state Activates, pauses, or returns a query rule to draft.
search_finish_query_rule Finishes a query rule permanently. Can't be undone.
search_create_synonym Creates a single synonym entry.
search_update_synonym Updates selected fields of a synonym entry.
search_batch_update_synonyms Adds synonyms in bulk from CSV. Existing synonyms are kept.
search_replace_all_synonyms Replaces all accepted synonyms of an index with CSV content.
search_hide_recent_search Hides a profile's recent searches. Can't be undone with the MCP tools.
search_create_index_directory Creates a folder for AI search indices.
search_rename_index_directory Renames an AI search index folder.
search_attach_indices_to_directory Moves AI search indices into a folder.
search_create_synonym_directory Creates a synonym folder within an index.
search_rename_synonym_directory Renames a synonym folder.
search_attach_synonyms_to_directory Moves synonyms into a folder.

Example prompts:

  • "What are the top 10 search queries in my store this week?"
  • "List all query rules for the 'products' AI search index."
  • "Run a search for 'running shoes' and show me the top results."
  • "Add 'sneakers' and 'trainers' as synonyms in the 'products' index."

AI (Predictions, AB Tests)

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for exploring AI predictions and AB tests, and for finding AI recommendation campaigns and AI search indices by name. You can also create, update, and copy AI predictions and AB tests, calculate the sample size for an AB test, and manage AB test folders.

Tool Description
ai_list_predictions Lists available AI prediction models.
ai_get_prediction Retrieves details of a specific AI prediction model.
ai_list_abtests Lists AB tests for AI recommendation campaigns or AI search indices.
ai_get_abtest Retrieves details of a specific AB test.
ai_list_recommendations Finds AI recommendation campaigns by name.
ai_get_recommendation Retrieves details of a specific AI recommendation campaign.
ai_list_search_indices Finds AI search indices by name.
ai_get_search_index Retrieves the configuration of a specific AI search index.
ai_create_prediction Creates an AI prediction model (draft unless activated).
ai_update_prediction Updates selected fields of an AI prediction model.
ai_copy_prediction Creates an inactive draft copy of an AI prediction model.
ai_create_abtest Creates an AB test for AI recommendation campaigns or AI search indices.
ai_update_abtest Overwrites an AB test that hasn't started. Full replace: omitted fields are cleared.
ai_duplicate_abtest Creates a new AB test from a finished one.
ai_get_abtest_variants Shows which AB tests use given AI recommendation campaigns or AI search indices.
ai_calculate_abtest_sample_size Calculates the number of profiles each variant needs.
ai_create_abtest_directory Creates a folder for AB tests.
ai_rename_abtest_directory Renames an AB test folder.
ai_attach_abtests_to_directory Moves AB tests into a folder.

Example prompts:

  • "What AI prediction models are available in my workspace?"
  • "Show me the details of the AB test named 'Homepage reco test'."
  • "Create an AB test that compares the 'Similar products' and 'Top sellers' AI recommendation campaigns."

CRM

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for looking up customer profiles 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

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for exploring and managing loyalty promotions, voucher pools, and personalized promotions (handbills). You can create and update promotions, voucher pools, voucher codes, and handbill configurations, and import promotions in bulk.

Tool Description
loyalty_list_promotions Lists promotions (not personalized 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.
loyalty_create_coupon Creates a voucher pool.
loyalty_update_coupon Updates a voucher pool's name, description, or validity dates.
loyalty_create_voucher Adds a single voucher code to a pool.
loyalty_bulk_create_vouchers Adds many voucher codes to a pool at once.
loyalty_count_coupon_vouchers Counts a voucher pool's codes by status and saves the counts on the pool.
loyalty_create_promotion Creates a promotion.
loyalty_upsert_promotion Updates a promotion, or creates it if it doesn't exist. Partial update: omitted fields keep their stored values, and an explicit null clears a field.
loyalty_duplicate_promotion Creates a draft copy of a promotion.
loyalty_import_promotions Queues up to 1000 promotions for asynchronous import.
loyalty_create_handbill Creates a personalized promotion (handbill) configuration.
loyalty_update_handbill Updates a personalized promotion (handbill) configuration. Only the fields provided are changed; others keep their current values. Variants and control group are replaced as a whole, so send the complete list.
loyalty_duplicate_handbill Creates a draft copy of a personalized promotion (handbill) configuration.

Example prompts:

  • "List all active promotions."
  • "What are the terms of the 'VIP Summer Discount' promotion?"
  • "Create a voucher pool named 'Black Friday' valid from November 27 to November 30."

Assets

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for exploring assets in your workspace, including catalogs, Brickworks schemas, records, and external sources, code snippets, and API keys. Also supports generating and previewing Brickworks records. You can also create item catalogs and add items to them, configure catalog filtering, and create and update Brickworks schemas, records, external sources, and personalizations.

Tool Description
assets_list_catalogs Lists item catalogs.
assets_get_catalog Retrieves the indexed fields of a catalog.
assets_list_snippets Lists code snippets.
assets_get_snippet Retrieves the content of a specific snippet.
assets_list_brickworks_schemas Lists Brickworks schemas.
assets_get_brickworks_schema Retrieves a Brickworks schema with its field definitions, type, and audience.
assets_list_brickworks_records Lists the records of one Brickworks schema, with optional filtering by status, slug, or field values.
assets_get_brickworks_record Retrieves a Brickworks record with its stored field values (not rendered for a profile).
assets_list_brickworks_externals Lists Brickworks external sources.
assets_get_brickworks_external Retrieves details of a specific Brickworks external source.
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 field values that you provide, based on a schema, without saving a record.
assets_list_apikeys Lists API keys available in the workspace.
assets_get_apikey Retrieves details of a specific API key.
assets_create_catalog Creates an empty item catalog.
assets_upsert_catalog_items Adds items to a catalog or replaces existing ones, matched by item key (up to 1000 per call). An existing item is fully replaced, not merged. If any item is invalid, nothing is saved.
assets_list_catalog_fields Lists the field names used by items in a catalog.
assets_enable_catalog_filtering Enables filtering on selected catalog fields.
assets_disable_catalog_filtering Disables filtering for a catalog and removes its saved filters.
assets_get_brickworks_docs Returns built-in reference guides on Brickworks.
assets_create_brickworks_schema Creates a Brickworks schema.
assets_update_brickworks_schema Overwrites a Brickworks schema. Full replace: omitted fields are cleared.
assets_create_brickworks_record Creates a Brickworks record.
assets_update_brickworks_record Updates a Brickworks record. Full replace: omitted fields, including the slug and personalization, are cleared.
assets_duplicate_brickworks_record Creates a copy of a Brickworks record.
assets_create_brickworks_external Creates a Brickworks external source.
assets_update_brickworks_external Updates a Brickworks external source. Only the fields provided are changed; others keep their current values. The HTTP properties are required, and the URL and method are always overwritten. Other HTTP settings (headers, params, auth, body) can be changed but not removed.
assets_list_brickworks_personalizations Lists personalizations of a Brickworks schema.
assets_get_brickworks_personalization Retrieves a Brickworks personalization with its decision trees.
assets_create_brickworks_personalization Creates a Brickworks personalization (per-segment field values).
assets_update_brickworks_personalization Updates a Brickworks personalization. Omitted description and decision trees are cleared.

Example prompts:

  • "List all item catalogs in my workspace."
  • "What does the 'product-card' Brickworks schema look like?"
  • "Create a Brickworks record based on the 'product-card' schema."

Events

WARNING: Results of this tool may include personal data or other sensitive information. See Data privacy and third-party AI clients before connecting an AI client.

Tools for exploring event definitions, including available events and their parameters, and for browsing the event history of a specific profile. You can also register new events, add parameters to events, and manage the labels, descriptions, and visibility of events and parameters, including workspace-wide parameter defaults.

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 a profile's event history. Without a start date, only the last 2 hours are returned.
events_get_profile_event Fetches the full detail of a single event for a profile.
events_get_events_docs Returns built-in reference guides on events.
events_get_action Retrieves an event with its profile identification settings.
events_create_action Registers a new event in the workspace.
events_update_action Overwrites an event's label, description, visibility, and identification settings. Full replace: omitted fields are cleared.
events_set_action_visibility Shows or hides an event in the Synerise platform.
events_add_action_parameter Adds a parameter to an event.
events_update_action_parameter Overrides a parameter's label, description, and visibility for one event.
events_set_parameter_visibility Shows or hides a parameter of one event.
events_restore_parameter_default Restores an event parameter to the workspace default.
events_list_parameter_defaults Lists workspace-wide parameter defaults.
events_update_parameter_default Updates a workspace-wide parameter default. The change applies to every event that hasn't overridden it.

Example prompts:

  • "What events are available in my workspace?"
  • "What parameters does the 'product.addToCart' event accept?"
  • "Hide the 'test.event' event in the Synerise platform."

Mobile SDK guidance

These tools provide structured guidance for implementing and troubleshooting the Synerise Mobile SDK (iOS and Android). They retrieve documentation, setup guides, best practices, FAQs, and diagnostic information from Synerise's built-in documentation, and support integration validation.

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.

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. 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.

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 to revisit what the Synerise MCP Server enables, or go to Getting started if you have not yet configured your AI client.

Canonical URL: https://hub.synerise.com/developers/mcp/available-tools