Tools
Tool catalog
What your AI assistant can do with VYG, including which tools make changes.
These are the tools your AI assistant gets when it connects to https://api.vyg.app/mcp. Your assistant
picks the right tool for your question, so you do not need to name tools yourself. This page is for
checking what is possible and what each tool touches.
How to read the table:
- Reads or changes. "Reads only" tools never change anything. "Makes changes" tools create or edit something in your account, such as a draft campaign or a discount rule; your assistant should ask you before it runs one.
- Who can call it. "Sign-in only" tools work when a person signs in with their VYG account. They do not work with an API key. See Authentication.
- REST. The same operation in the REST API, when there is one.
Find Shopify developer tools on the Shopify tools page, and the email channel tools on the Email tools page. Old tool names and their current names are in the migration guide.
Brand
The brand the credential belongs to: name, plan, connected apps and support contacts.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
get_brand | Brand profile. View your business details, website, plan, connected apps and support contacts. | Reads only | Sign-in or API key | GET /v1/brand |
Conversations
Customer conversations and their messages, conversation search, AI-generated conversation insights, and contacts.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
search_conversations | Search conversations. Find customer conversations about a topic. | Reads only | Sign-in or API key | GET /v1/conversations/search |
list_conversations | Recent conversations. View conversations, newest first. | Reads only | Sign-in or API key | GET /v1/conversations |
list_conversation_insights | Conversation insights. See common themes in customer conversations, including checkout issues, post-purchase concerns and product questions. | Reads only | Sign-in or API key | GET /v1/brand/insights |
list_insight_conversations | Conversations behind an insight. View the conversations behind an insight, with customer details and message previews. | Reads only | Sign-in or API key | GET /v1/brand/insights/{insight_id}/conversations |
get_conversation_details | Conversation. Get the full details of a specific conversation including all messages, customer info, checkout/cart data, and goal state changes. | Reads only | Sign-in or API key | MCP only |
get_conversation_trace | Why this conversation happened. Trace a conversation back to what started it and forward to what it produced: the triggering event (checkout, cart, custom event, order, subscription event or signup list), the campaign and each step of its run (entered, skipped with the reason, sent, failed), the messages by status with the next scheduled send time (messages wait for quiet hours or a wait step), and whether it led to a recovered order. | Reads only | Sign-in or API key | GET /v1/conversations/{conversation_id}/trace |
Customers
Customer profiles, lookup, activity timelines, a customer's orders and subscriptions, and the customer field catalog.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
list_customer_fields | Customer fields. View customer fields. | Reads only | Sign-in or API key | GET /v1/customers/fields |
list_customers | List customers. View customers with spending, order counts and recent activity. | Reads only | Sign-in or API key | GET /v1/customers |
search_customers | Find a customer. Find customers by email, phone number or customer ID. | Reads only | Sign-in or API key | GET /v1/customers/search |
get_customer | Customer profile. View a customer’s contact details, order totals and recent activity. | Reads only | Sign-in or API key | GET /v1/customers/{id} |
get_customer_activity | Customer activity. View a customer’s activity, newest first: website visits, orders, subscriptions and messages. | Reads only | Sign-in or API key | GET /v1/customers/{id}/timeline |
list_customer_orders | Customer order history. View a customer’s orders, newest first, including linked profiles. | Reads only | Sign-in or API key | GET /v1/customers/{id}/orders |
list_customer_subscriptions | Customer subscriptions. View a customer’s subscriptions, newest first, including linked profiles. | Reads only | Sign-in or API key | GET /v1/customers/{id}/subscriptions |
list_customer_segments | Customer's segments. View the active segments a customer currently belongs to, most recently joined first. | Reads only | Sign-in or API key | GET /v1/customers/{id}/segments |
Segments
Saved customer segments: rules, size estimates, members and join/leave history.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
list_segments | List segments. View saved customer segments, newest first, with their member counts and last update time. | Reads only | Sign-in or API key | GET /v1/segments |
estimate_segment | Estimate segment size. Check how many customers match a segment. | Reads only | Sign-in or API key | POST /v1/segments/estimate |
get_segment | Segment details. View a segment’s rules, version and latest member count. | Reads only | Sign-in or API key | GET /v1/segments/{id} |
create_segment | Create a segment. Create a customer segment using your chosen rules. | Makes changes | Sign-in only | POST /v1/segments |
update_segment | Change a segment's rule. Update a segment’s rules. | Makes changes | Sign-in only | PATCH /v1/segments/{id} |
archive_segment | Archive a segment. Archive a segment to stop updates and remove it from the active list. | Makes changes | Sign-in only | POST /v1/segments/{id}/archive |
get_segment_audience | Segment audience. View a segment’s latest member count, update time and status. | Reads only | Sign-in or API key | GET /v1/segments/{id}/audience |
list_segment_members | Segment members. View the customers in a segment, with their email and phone number. | Reads only | Sign-in or API key | GET /v1/segments/{id}/members |
list_segment_history | Segment join and leave history. See who joined or left a segment, newest updates first. | Reads only | Sign-in or API key | GET /v1/segments/{id}/history |
Commerce
The store's orders, subscription contracts and product catalog.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
list_orders | Orders. View orders, newest first. | Reads only | Sign-in or API key | GET /v1/commerce/orders |
get_order | Order. View an order and its items. | Reads only | Sign-in or API key | GET /v1/commerce/orders/{id} |
list_subscriptions | Subscriptions. View subscriptions. | Reads only | Sign-in or API key | GET /v1/commerce/subscriptions |
get_subscription | Subscription. View a subscription by its external ID. | Reads only | Sign-in or API key | GET /v1/commerce/subscriptions/{id} |
list_products | Products. View products in your Shopify store. | Reads only | Sign-in or API key | GET /v1/commerce/products |
get_product | Product. View a product by ID. | Reads only | Sign-in or API key | GET /v1/commerce/products/{id} |
Insights
Brand-wide lifetime value, RFM tiers, top products and customers at risk of churning.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
get_lifetime_value | Customer lifetime value. See total and average customer spending, with a breakdown by spend range. | Reads only | Sign-in or API key | GET /v1/insights/ltv |
get_lifetime_value_by_year | Lifetime value by year. See total completed-order revenue per calendar year for the last 5 years, in the primary currency. | Reads only | Sign-in or API key | GET /v1/insights/ltv-by-year |
get_rfm_tiers | RFM tiers. See customer groups based on how recently they bought, how often they buy and how much they spend. | Reads only | Sign-in or API key | GET /v1/insights/rfm |
get_top_products | Top-selling products. See top products by revenue and order count, based on completed orders. | Reads only | Sign-in or API key | GET /v1/insights/products |
list_at_risk_customers | Customers at risk of churning. Find repeat customers who are overdue for their next order. | Reads only | Sign-in or API key | GET /v1/insights/at-risk |
get_lifecycle_stages | Lifecycle stage counts. See lifecycle stage counts (Visitors, Customers, Repeat Customers, and more) read from the brand seeded lifecycle segments, with conversion ratios between adjacent stages. | Reads only | Sign-in or API key | GET /v1/insights/lifecycle |
get_customer_overview | Customer overview. See active buyers, average order value, orders per customer and total value for a 7, 30 or 90 day window, with the previous window for comparison, daily series for both windows and the new vs returning customer value split. | Reads only | Sign-in or API key | GET /v1/insights/overview |
get_product_performance | Product performance. See per-product viewers, add to cart, checkouts, orders, buyers, units and revenue for a 7, 30 or 90 day window with the previous window for comparison, and the store funnel from visits to purchases. | Reads only | Sign-in or API key | GET /v1/insights/product-performance |
get_first_products | First products bought. See which products customers buy first: the top 10 line-item titles from each customer's earliest completed order, with a count and share of all purchasing customers. | Reads only | Sign-in or API key | GET /v1/insights/first-product |
get_acquisition_sources | First-order acquisition sources. See where first orders come from: customers counted by the utm_source of their earliest completed order, falling back to referrer_host then 'direct'. | Reads only | Sign-in or API key | GET /v1/insights/sources |
Campaigns
Campaigns, message variants, campaign building options and performance stats.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
get_event_journey | Where an event went. Follow one event through every campaign: pass exactly one of custom_event_id, checkout_id, order_id or subscription_event_id. | Reads only | Sign-in or API key | GET /v1/events/journey |
get_performance_stats | Performance stats. View performance for a date range or campaign, and compare periods. | Reads only | Sign-in or API key | GET /v1/stats |
list_campaigns | List campaigns. View campaigns and their status. | Reads only | Sign-in or API key | GET /v1/campaigns |
create_campaign | Create a campaign. Create a campaign draft with a trigger, messages and optional timing and discount settings. | Makes changes | Sign-in only | POST /v1/campaigns |
compare_campaigns | Compare campaigns. Compare campaign performance side by side. | Reads only | Sign-in or API key | GET /v1/campaigns/compare |
get_campaign_composer_options | Campaign building options. View the triggers, discounts, message variables and audience filters available for a campaign. | Reads only | Sign-in or API key | GET /v1/campaigns/composer-options |
get_campaign | Campaign setup. View a campaign’s trigger, timing, messages and status. | Reads only | Sign-in or API key | GET /v1/campaigns/{campaign_id} |
list_campaign_activity | Campaign run activity. One campaign's run activity, newest first: every event that entered it, each step it ran or skipped (with the skip reason, such as a filter, the re-entry limit, quiet hours or holdout), failures, and the conversation each run produced, plus counts by step state and skip reason for the window. | Reads only | Sign-in or API key | GET /v1/campaigns/{campaign_id}/activity |
rename_campaign | Rename a campaign. Rename a campaign draft. | Makes changes | Sign-in only | PATCH /v1/campaigns/{campaign_id} |
update_campaign_schedule | Change campaign dates. Change the start or end date of a campaign draft. | Makes changes | Sign-in only | PUT /v1/campaigns/{campaign_id}/schedule |
update_campaign_messages | Edit campaign messages. Edit the main messages in a campaign draft. | Makes changes | Sign-in only | PUT /v1/campaigns/{campaign_id}/messages |
update_campaign | Change a campaign. Change a campaign’s steps (waits, split weights, re-entry, added or removed text and AI agent steps), the text of any step, or its holdout group, and update the running flow to match. | Makes changes | Sign-in only | PATCH /v1/campaigns/{campaign_id}/flow |
set_campaign_status | Turn a campaign on or off. Turn a campaign on (active) or off (paused). | Makes changes | Sign-in only | POST /v1/campaigns/{campaign_id}/status |
list_message_variants | Message variants. View a campaign’s message alternatives and current test. | Reads only | Sign-in or API key | GET /v1/campaigns/{campaign_id}/variants |
add_message_variant | Add a message variant. Add alternative wording for a campaign message. | Makes changes | Sign-in only | POST /v1/campaigns/{campaign_id}/variants |
update_message_variant | Update a message variant. Edit wording in a running message test. | Makes changes | Sign-in only | PATCH /v1/campaigns/{campaign_id}/variants/{variant_id} |
Discounts
Reusable discount rules in the brand's discount library.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
create_discount | Create a discount. Create a percentage, fixed-amount or free-shipping discount. | Makes changes | Sign-in only | POST /v1/discounts |
update_discount | Update a discount. Edit a discount’s value, duration, name, code prefix or minimum purchase. | Makes changes | Sign-in only | PATCH /v1/discounts/{discount_rule_id} |
Integrations
Connected apps, event types, and custom integration providers and their event definitions.
| Tool | What it does | Reads or changes | Who can call it | REST |
|---|---|---|---|---|
list_providers | Custom data sources. View your custom data sources. | Reads only | Sign-in or API key | GET /v1/providers |
get_provider | Custom data source. View a custom data source and its settings. | Reads only | Sign-in or API key | GET /v1/providers/{provider_id} |
create_provider | Add a custom data source. Add a custom data source and get its webhook signing secret. | Makes changes | Sign-in or API key | POST /v1/providers |
update_provider | Update a custom data source. Update a data source’s name, status or settings. | Makes changes | Sign-in or API key | PATCH /v1/providers/{provider_id} |
list_event_definitions | Custom event definitions. View the event types registered for a custom data source. | Reads only | Sign-in or API key | GET /v1/providers/{provider_id}/event-definitions |
get_event_definition | Custom event definition. View a registered event type and its payload requirements. | Reads only | Sign-in or API key | GET /v1/providers/{provider_id}/event-definitions/{definition_id} |
create_event_definition | Create a custom event definition. Register an event type and its expected payload. | Makes changes | Sign-in or API key | POST /v1/providers/{provider_id}/event-definitions |
update_event_definition | Update a custom event definition. Update an event type. | Makes changes | Sign-in or API key | PATCH /v1/providers/{provider_id}/event-definitions/{definition_id} |
list_integrations | Connected apps. View your connected apps. | Reads only | Sign-in or API key | GET /v1/integrations |
list_event_types | Event types. View the available event types. | Reads only | Sign-in or API key | GET /v1/event-types |
Shopify
Query the brand's connected Shopify store and look up Shopify developer documentation.
Klaviyo
Read the brand's Klaviyo data and search the Klaviyo API documentation.
Help and documentation
What this connection can do, and the VYG documentation behind each tool.