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

Four email tools are on api.vyg.app for brands with the beta:email-channel feature (Beta features): klaviyo_import brings Klaviyo flows and templates over as drafts, email_templates creates new drafts and reviews and approves them, email_broadcasts reads broadcasts and AI drafts, and manage_email_broadcast schedules, changes, pauses, resumes and cancels broadcasts and adds variants. All four are sign-in only. See Move from Klaviyo and Email broadcasts. The other email channel tools are served to LiveRecover operators on https://agents-mcp.vyg.app/mcp, not on api.vyg.app; see Email tools. Old tool names and their current names are in the migration guide.

The klaviyo tool works in your own Klaviyo account through the Klaviyo connection saved in Settings, Integrations. Your assistant can look up profiles, lists, segments, flows, campaigns, templates and Klaviyo reports, and, with your approval, create or change lists, segments, flows, campaigns and templates. It never asks for or shows your Klaviyo API key. New flows are created as drafts and new campaigns are not sent; turning a flow on, sending a campaign or subscribing people only happens when you ask for it. Reading needs integrations:read and changes need integrations:write and a sign-in with your own VYG login; a brand API key can read but not change Klaviyo data. Your Klaviyo key must include the scopes for what you ask (for example segments:write to create a segment).

Brand

The brand the credential belongs to: name, plan, connected apps and support contacts.

ToolWhat it doesReads or changesWho can call itREST
get_brandBrand profile. View your business details, website, plan, connected apps and support contacts.Reads onlySign-in or API keyGET /v1/brand

Conversations

Customer conversations and their messages, conversation search, AI-generated conversation insights, and contacts.

ToolWhat it doesReads or changesWho can call itREST
conversationsConversations. Read the brand's customer text conversations.Reads onlySign-in or API keyMCP only
get_checkout_purchase_likelihoodCheckout purchase likelihood. Read the cart and per-product purchase likelihood for a checkout of the calling brand.Reads onlySign-in or API keyGET /v1/checkouts/{checkout_id}/purchase-likelihood

Customers

Customer profiles, lookup, activity timelines, a customer's orders and subscriptions, and the customer field catalog.

ToolWhat it doesReads or changesWho can call itREST
customersCustomers. Read the brand's customers.Reads onlySign-in or API keyMCP only

Segments

Saved customer segments: rules, size estimates, members and join/leave history.

ToolWhat it doesReads or changesWho can call itREST
segmentsSegments. Read the brand's saved customer segments.Reads onlySign-in or API keyMCP only
manage_segmentManage segments. Change the brand's saved customer segments.Makes changesSign-in onlyMCP only

Insights

Brand-wide lifetime value, RFM tiers, top products and customers at risk of churning.

ToolWhat it doesReads or changesWho can call itREST
statsStats. Read the brand's dashboard numbers for one period: customer insights, Cockpit metrics and funnel, product performance, LiveRecover SMS recovery numbers (recovered revenue and orders, and the Telegram line for brands with Telegram), LiveRecover campaign performance, and the product list.Reads onlySign-in or API keyMCP only
reportsReports. Read the brand's reports (the Reports section of the vyg.ai app).Reads onlySign-in or API keyMCP only
manage_reportCreate or change a report. Create and change the brand's custom reports.Makes changesSign-in or API keyMCP only
manage_funnelEdit the Cockpit funnel. Read or change the steps of the brand's Cockpit conversion funnel.Makes changesSign-in or API keyMCP only
cdp_insights_propensityPurchase propensity insights. Read purchase propensity band counts for the authenticated brand, expected buyers for 30 and 90 days, and model readiness.Reads onlySign-in or API keyMCP only
get_website_breakdownWebsite traffic breakdown. See website traffic from the VYG web pixel for a date range: page views, unique visitors and conversions grouped by page, landing page, traffic source (UTM source, medium, campaign, referrer), event, page variant or a custom event property.Reads onlySign-in or API keyPOST /v1/website/breakdown

Campaigns

Campaigns, message variants, campaign building options and performance stats.

ToolWhat it doesReads or changesWho can call itREST
campaignsCampaigns. Read the brand's campaigns.Reads onlySign-in or API keyMCP only
manage_campaignCreate or change a campaign. Create, change or copy a campaign.Makes changesSign-in onlyMCP only
email_broadcastsEmail broadcasts. Read the brand's email broadcasts: one live template sent to an email audience once or on a repeating schedule.Reads onlySign-in onlyMCP only
manage_email_broadcastManage email broadcasts. Create and change email broadcasts.Makes changesSign-in onlyMCP only

Discounts

Reusable discount rules in the brand's discount library.

ToolWhat it doesReads or changesWho can call itREST
create_discountCreate a discount. Create a percentage, fixed-amount or free-shipping discount.Makes changesSign-in onlyPOST /v1/discounts
update_discountUpdate a discount. Edit a discount’s value, duration, name, code prefix or minimum purchase.Makes changesSign-in onlyPATCH /v1/discounts/{discount_rule_id}

Integrations

Connected apps, event types, and custom integration providers and their event definitions.

ToolWhat it doesReads or changesWho can call itREST
data_sourcesData sources. Read where the brand's customer and event data comes from: connected apps (Shopify, Klaviyo, Zendesk SMS and others), custom data sources (including the WooCommerce and BigCommerce templates) and the VYG Web Pixel.Reads onlySign-in or API keyMCP only
manage_data_sourceChange data sources. Add or change the brand's custom data sources and the events they send.Makes changesSign-in or API keyMCP only
klaviyo_importKlaviyo import. Import the brand's Klaviyo flows and email templates using the Klaviyo connection saved in Settings, Integrations.Makes changesSign-in onlyMCP only
klaviyoKlaviyo. Work in the brand's Klaviyo account through its saved Klaviyo connection: look up profiles, events, lists, segments, flows, campaigns, templates and performance reports, and create or change lists, segments, flows, campaigns, templates and profiles.Makes changesSign-in or API keyMCP only
email_templatesEmail templates. Review and approve the brand's email templates, including the drafts the Klaviyo import created.Makes changesSign-in onlyMCP only

List building

Add subscribers to a live SMS sign-up campaign from your own site or app.

ToolWhat it doesReads or changesWho can call itREST
signup_formsSign-up forms. Read the brand’s SMS, WhatsApp and Telegram sign-up forms, including SMS forms that also collect email: list them, open one (channel, what it collects, ways in, schedule, texts, consent wording and the publish checklist), opt-in stats, published versions, where the form is installed, and recent sign-ups.Reads onlySign-in onlyMCP only
manage_signup_formChange a sign-up form. Create a sign-up form from a template, edit or discard its draft (name, display and timing settings, email collection and opt-in with beta:email-channel, texts), publish or schedule it (or cancel the schedule), pause or resume it, copy an old version back into the draft, duplicate it, or archive it.Makes changesSign-in onlyMCP only
subscribe_signup_formAdd a sign-up form subscriber. Add a person to a live sign-up form whose API way in is on.Makes changesSign-in or API keyMCP only
import_subscribersImport subscribers. Import a list of phone numbers, for example a sign-up sheet from an event, with a title.Makes changesSign-in or API keyMCP only

Onboarding

Sign up for LiveRecover from an AI agent with no account. Served on the public MCP start endpoint.

ToolWhat it doesReads or changesWho can call itREST
onboarding_startOnboarding start. Start a LiveRecover signup for a new brand.Makes changesNo account (/mcp/start)MCP only
onboarding_statusOnboarding status. Check where a LiveRecover signup stands.Reads onlyNo account (/mcp/start)MCP only
onboarding_set_passwordOnboarding set password. Set the password for a LiveRecover signup.Makes changesNo account (/mcp/start)MCP only
onboarding_connect_platformOnboarding connect platform. Connect the brand's store platform during a LiveRecover signup, or skip it.Makes changesNo account (/mcp/start)MCP only
onboarding_send_verificationOnboarding send verification. Email a 6-digit verification code to the signup email.Makes changesNo account (/mcp/start)MCP only
onboarding_verify_codeOnboarding verify code. Check the 6-digit code the user received by email.Makes changesNo account (/mcp/start)MCP only
onboarding_provision_accountOnboarding provision account. Create the LiveRecover account once the email is verified and a password is set.Makes changesNo account (/mcp/start)MCP only

Help and documentation

What this connection can do, and the VYG documentation behind each tool.

ToolWhat it doesReads or changesWho can call itREST
list_toolsWhat can I do?. List the tools this connection can use, grouped by area, with a one-line summary, whether each reads or changes data, and a link to its documentation.Reads onlySign-in or API keyMCP only
get_docsRead the VYG docs. Read VYG documentation from docs.vyg.ai.Reads onlySign-in or API keyMCP only
search_docsSearch the VYG docs. Search the VYG documentation (docs.vyg.ai) by keywords: guides for brand teams, custom integrations and webhooks, data collection, the API and the MCP tools.Reads onlySign-in or API keyMCP only
call_toolCall a tool by name. Call any tool this connection can use, by name.Makes changesSign-in or API keyMCP only

On this page