MCP · Tool reference

MCP tool reference

126 tools the AXO MCP server exposes, grouped by domain. Each lists the scope it requires — a token can only call tools at or below its scope. Generated from the server, so it never drifts from what an agent sees. (A handful of operator and diagnostic tools are available to connected agents at runtime but omitted here.)

Analytics & lift

Read performance, holdout lift, optimizer state, events, and sessions.

get_agent_usageread

AI assistant usage: conversations, messages, tokens, estimated cost.

no parameters
get_ai_generationsread

Read the AI generation history for a content variant — the prompt + guardrails snapshot + provider + model + DAM provenance that produced each piece of AI-generated content on this variant. Use to audit off-brand creative ("why does this image feel wrong?") or to trace why a specific variant looks the way it does. Returns { generations, count } with newest first. Each row carries prompt, response, model, tokens, inferred_cost, guardrails (brand_voice + active_briefs + segment), and dam_provider when the asset was push-through'd to a customer DAM.

1 parameter
ParameterTypeDescription
variant_id
required
stringcontent_variants.id to read provenance for.
get_analyticsread

Get dashboard analytics overview: total sessions, conversions, revenue, segment breakdown, and trend data for the current site.

1 parameter
ParameterTypeDescription
days
optional
numberNumber of days to look back (default: 30)
get_backtestread

Get backtest results showing segment performance, variant impact, conversion rates, and revenue attribution. Use this to evaluate how well personalization is working.

no parameters
get_eventsread

Get recent site events: pageviews, clicks, conversions, custom events.

1 parameter
ParameterTypeDescription
limit
optional
numberMax events (default 100)
get_form_funnelread

Form conversion funnel analytics: views → starts → submits → abandons, per form and per page, with field-level drop-off.

1 parameter
ParameterTypeDescription
window
optional
"24h" | "7d" | "30d" | "90d"Lookback window (default 30d)
get_lift_reportread

Get revenue lift analysis showing the incremental impact of personalization vs. control group.

no parameters
get_scorecardread

Get the AI Scorecard — the plain-language verdict on whether personalization is beating the 10% holdout control group. Returns status (winning/flat/losing/learning), site-level lift % with statistical significance (z-test p-value), with-AXO vs holdout conversion rates, and a per-segment breakdown. Falls back to a labeled projected lift when live holdout traffic is too thin. Prefer this over get_lift_report for "is the AI working?" questions.

1 parameter
ParameterTypeDescription
days
optional
integerNumber of days to look back (default: 30)
get_segment_performanceread

Performance metrics for a segment: sessions, conversions, rate, revenue, AOV.

1 parameter
ParameterTypeDescription
segment_id
required
stringSegment ID
get_sitemap_healthread

Sitemap crawl status, page counts, health metrics.

no parameters
get_tag_healthread

Tag health: recent beacon count, pageviews, personalizations, render errors, last event.

no parameters
get_variant_performanceread

Performance metrics for a content variant: impressions, conversions, rate, render errors.

1 parameter
ParameterTypeDescription
variant_id
required
stringVariant ID

Audience & segments

Query and build behavioral segments; look up, merge, and link profiles.

create_segmentwrite

Create a new custom behavioral segment with a name, description, and signal rules.

4 parameters
ParameterTypeDescription
name
required
stringSegment name
description
optional
stringBehavioral description
emoji
optional
stringEmoji icon
signal_rules
optional
objectMatching signal rules
delete_profileadmin

Permanently delete a profile and all associated data (GDPR erasure). Removes identifiers, unlinks sessions, deletes the profile.

1 parameter
ParameterTypeDescription
profile_id
required
stringProfile UUID to delete
export_audiencewrite

Export a segment's audience for a batch email campaign. Returns JSON rows by default; set format:"webhook" to POST them to a URL. For an email blast list set email_only:true — only profiles with a captured email are included (anonymous visitors excluded). Works for behavioral AND custom/affinity segments (auto-detected). include_pii is required to emit emails and is recorded for compliance.

6 parameters
ParameterTypeDescription
segment_id
required
stringSegment ID to export
format
optional
"json" | "webhook"Output format (default json)
destination
optional
stringWebhook URL (required when format=webhook)
email_only
optional
booleanOnly include profiles with an email; produce a campaign-ready email list (implies include_pii)
include_pii
optional
booleanInclude the profile email column (opt-in; audited)
include_affinities
optional
booleanAppend each profile's top-3 brand affinities
generate_audience_clusterswrite

Manually run K-Means machine-learning clustering against recent behavioral profile activity.

1 parameter
ParameterTypeDescription
k
optional
numberNumber of clusters to generate
get_audience_reportread

Get the audience intelligence report with behavioral clusters, engagement tiers, and actionable recommendations.

no parameters
get_profileread

Get detailed profile information including timeline, identifiers, CRM attributes, lifetime signals, session history, lead status (lead_captured history), and the opportunities this profile is a contact/lead on.

1 parameter
ParameterTypeDescription
profile_id
required
stringThe profile UUID to look up
get_segment_membersread

Paginated list of profiles in a segment with their identifiers.

3 parameters
ParameterTypeDescription
segment_id
required
stringSegment ID
limit
optional
numberMax results (default 50)
offset
optional
numberPagination offset
get_segmentsread

List all behavioral segments with session counts, conversion rates, and descriptions. Use this to understand how visitors are being classified.

no parameters
get_sessionsread

Get recent visitor sessions with behavioral signals, segment assignment, and page URLs. Useful for understanding real-time visitor behavior.

2 parameters
ParameterTypeDescription
limit
optional
numberMax results (default: 50)
segment
optional
stringFilter by segment ID
link_identifierwrite

Link a new identifier (email, phone, external_id) to a profile.

3 parameters
ParameterTypeDescription
profile_id
required
stringProfile ID
type
required
"email" | "phone" | "external_id"Identifier type
value
required
stringIdentifier value
list_dedup_candidatesread

Find profiles sharing identifiers (merge candidates for deduplication).

no parameters
list_leadsread

List captured leads (lead_captured events) for this site: contact info, scheduled appointment slot, behavioral segment, and source page.

no parameters
merge_profilesadmin

Merge two profiles. Moves identifiers, sessions, conversions from source to target, deletes source.

2 parameters
ParameterTypeDescription
source_id
required
stringProfile to merge FROM (deleted)
target_id
required
stringProfile to merge INTO (kept)
search_profilesread

Search visitor profiles by email, segment, or identification status. Returns profile list with identifiers and session counts.

4 parameters
ParameterTypeDescription
search
optional
stringSearch by email or identifier value
segment
optional
stringFilter by segment ID
identified
optional
"true" | "false"Filter by identified status
limit
optional
numberMax results (default: 50, max: 200)
unlink_identifierwrite

Remove an identifier from a profile.

2 parameters
ParameterTypeDescription
profile_id
required
stringProfile ID
identifier_id
required
stringIdentifier record ID
update_profilewrite

Update a profile segment override or lifetime signals.

3 parameters
ParameterTypeDescription
profile_id
required
stringProfile ID
segment_id
optional
stringOverride segment
lifetime_signals
optional
objectLifetime signal data
update_segmentwrite

Update a segment: rename, edit description, change emoji, visibility, or signal rules.

6 parameters
ParameterTypeDescription
id
required
stringSegment ID
display_name
optional
stringNew display name
description
optional
stringNew description
emoji
optional
stringNew emoji
visible
optional
booleanShow/hide segment
signal_rules
optional
objectNew signal rules

Placements & personalization

Author zones and variants, wire placements, and manage the render surface.

attach_asset_to_variantwrite

Attach a library asset to a content variant field — overwrites whatever image was on that field with the asset's blob_url. Also copies the asset's provenance (prompt, brief / reference / planner attribution, tags) into the variant's generated_metadata so the audit trail follows the image. Returns { ok, asset_id, variant_id, blob_url, field_key }. Use after search_assets surfaces an existing asset that matches what the operator wants — saves a generation call. The variant's image_url is also synced to the asset's blob_url so the runtime tag picks it up immediately.

4 parameters
ParameterTypeDescription
asset_id
required
stringAsset id from search_assets (asset_<uuid> shape).
variant_id
required
stringcontent_variants.id to attach to.
field_key
required
stringThe payload field key on the variant to overwrite (e.g. "image_url", "hero_image_url").
alt
optional
stringOptional alt text override. When omitted, the variant's existing image_alt is preserved.
author_moveread

Author a "move object" placement: relocate an EXISTING element on the page to a new location, WITHOUT changing its copy or injecting new content (pure rearrangement). Creates a source zone (element_selector = the element to move) + a move_object content variant whose payload carries the destination anchor + position. Use after a two-pick (the extension / preview picker gives you source_selector + dest_selector). Target ONE segment via segment_id, OR all_visitors:true for everyone (the default — moves are usually global). CAUTION: once published this ships to the live site within ~60s. To preview without persisting on a no-tag site, use the extension demo flow instead.

8 parameters
ParameterTypeDescription
page_pattern
required
stringURL pattern the move applies to (e.g. "/", "/blog/*")
source_selector
required
stringCSS selector of the EXISTING element to relocate (the object to move)
dest_selector
required
stringCSS selector of the destination anchor to move it next to / into
position
optional
"before" | "after" | "inside_start" | "inside_end"Where to place the source relative to the destination. Default "after". ("replace" is intentionally not allowed for a move — it would destroy the destination.)
zone_key
optional
stringZone identifier. Defaults to a generated "move_*" key.
display_name
optional
stringHuman-readable name for the move.
segment_id
optional
stringAudience segment. Omit when all_visitors is true.
all_visitors
optional
booleanApply to ALL visitors regardless of segment (default true for moves). When false, provide segment_id.
clone_trigger_templatewrite

Clone a system or site template into a new site-owned template.

2 parameters
ParameterTypeDescription
template_id
required
stringSource template ID
name
optional
stringName for the clone
configure_product_recowrite

Configure a product_reco variant: choose recommendation mode (auto / curated / mixed), retrieval strategy, and pin curated products. Use list_products to find product IDs.

6 parameters
ParameterTypeDescription
variant_id
required
stringExisting product_reco variant ID
source
required
"auto" | "curated" | "mixed"auto: Vibe Engine picks all products. curated: only show pinned product_ids. mixed: pinned products first, engine fills the rest.
strategy
optional
"session_behavior" | "bestsellers" | "new_arrivals" | "similar"Engine retrieval strategy (used when source=auto or mixed). Default session_behavior.
limit
optional
integerMax products to render (default 5).
category
optional
stringRestrict candidates to this category (case-insensitive exact match).
product_ids
optional
string[]Catalog product IDs to pin. Required when source=curated. Optional when source=mixed.
create_campaignwrite

Create a new campaign with a brief (objective, offer, tone, themes).

7 parameters
ParameterTypeDescription
name
required
stringCampaign name
brief
optional
objectCampaign brief
status
optional
"active" | "draft" | "paused" | "archived"
starts_at
optional
stringISO-8601 start date for automated scheduling
ends_at
optional
stringISO-8601 end date for automated scheduling
eligibility
optional
objectAdvanced segment matching rules (e.g. segment_member, audience_signals)
priority
optional
numberEvaluation priority (higher = evaluated first)
create_content_variantwrite

Create a personalized content variant for a zone + segment combination. For product_reco variants, create with an empty payload ({}) and then call configure_product_reco to set the recommendation mode and curated products.

7 parameters
ParameterTypeDescription
zone_id
required
stringZone ID
segment_id
optional
stringTarget segment ID (legacy mode, or mirrored from eligibility)
type
required
"overlay" | "hero_swap" | "copy_swap" | "product_reco" | "move_object"Variant type
payload
required
objectVariant payload. For overlay/hero_swap/copy_swap: { headline, body, cta, image_url }. For product_reco: pass {} and configure via configure_product_reco. For move_object: { dest_selector, position } — but prefer author_move, which also creates the source zone.
eligibility
optional
objectAdvanced segment matching rules (e.g. segment_member, audience_signals)
priority
optional
numberEvaluation priority (higher = evaluated first)
campaign_id
optional
stringLink this variant to an orchestration campaign
create_formwrite

Create a reusable lead-capture form template. The payload is the form design; it is copied onto each placement.

2 parameters
ParameterTypeDescription
name
required
stringInternal template name
payload
required
objectForm design: { title, cta_text, tcpa_text, accent_color, fields (subset of name/email/phone), calendar_enabled }
create_page_configwrite

Create a page type configuration for sitemap analysis.

3 parameters
ParameterTypeDescription
page_type
required
stringPage type (product, category, blog)
url_pattern
required
stringURL pattern to match
selectors
optional
objectCSS selectors for page elements
create_triggerwrite

Create a new triggered message. Requires name, mode (immediate|dormancy), watch_event, and at least one destination.

13 parameters
ParameterTypeDescription
name
required
stringHuman-readable name
description
optional
string
mode
required
"immediate" | "dormancy"Fire mode
watch_event
required
stringEvent type to watch
cancel_event
optional
stringEvent that cancels dormancy
criteria
optional
objectMatching criteria
delay_ms
optional
numberDormancy delay in ms
window_ms
optional
numberCancel-event window in ms
identifier_type
optional
"email" | "phone" | "device" | "external_id" | "profile_id"
destinations
required
object[]Destination configs
cooldown_per_profile_ms
optional
number
global_rate_limit_per_min
optional
number
optimization_mode
optional
"axo_bandit" | "external"Optimization mode (axo_bandit or external)
create_trigger_templatewrite

Create a new site-owned payload template for triggered messages.

5 parameters
ParameterTypeDescription
name
required
stringTemplate name
description
optional
string
format
required
"json" | "html" | "form"Template format
body
required
stringTemplate body with mustache placeholders
example_destination
optional
stringIntended destination type
create_zonewrite

Create a new personalization zone on the site. For lightbox zones (zone_key="lightbox"), pass display_rules to set when/where/how-often the popup fires; otherwise call list_lightbox_presets and use one of those rule objects verbatim.

6 parameters
ParameterTypeDescription
page_pattern
required
stringURL pattern (e.g. "/", "/product*")
zone_key
required
stringZone identifier
display_name
required
stringHuman-readable name
element_selector
optional
stringCSS selector
position
optional
stringPosition (before/after/replace)
display_rules
optional
objectLightbox-only display rules (DisplayRules shape — see lib/display-rules.ts). Sub-objects: trigger {type, delay_ms?, scroll_pct?, inactivity_ms?}, page_targeting {exclude[]}, audience {visitor_type, converted, device[]}, frequency {cap, n_days?, cooldown_seconds?}, suppression {after_dismiss_days?, after_convert_days?, mutual_exclusion?}. The API sanitizes — bad fields are dropped, not 400d. Ignored on non-lightbox zones.
delete_campaignadmin

Delete a campaign permanently.

1 parameter
ParameterTypeDescription
campaign_id
required
stringCampaign ID
delete_content_variantadmin

Soft-delete a content variant. The variant is hidden immediately but recoverable via restore_content_variant within 30 days. A history snapshot is automatically created before deletion.

1 parameter
ParameterTypeDescription
variant_id
required
stringVariant ID
delete_formwrite

Delete a form template. Already-deployed placements are unaffected (placements copy the payload).

1 parameter
ParameterTypeDescription
id
required
stringForm template ID
delete_page_configadmin

Delete a page type configuration.

1 parameter
ParameterTypeDescription
config_id
required
stringConfig ID
delete_triggeradmin

Permanently delete a trigger and its fire history.

1 parameter
ParameterTypeDescription
trigger_id
required
stringTrigger ID
delete_trigger_templateadmin

Delete a site-owned trigger payload template.

1 parameter
ParameterTypeDescription
template_id
required
stringTemplate ID
delete_zoneadmin

Delete a zone and all its content variants.

1 parameter
ParameterTypeDescription
zone_id
required
stringZone ID
draft_content_variantwrite

Use AI to generate a content variant draft for a segment + zone. Returns suggested headline, body, and CTA.

3 parameters
ParameterTypeDescription
segment_id
required
stringTarget segment
zone_key
optional
stringZone key (e.g. "hero")
variant_type
optional
"overlay" | "hero_swap" | "copy_swap"Variant type
get_optimizerread

Get the multi-armed bandit optimizer status. Shows Thompson Sampling allocation weights, which variants are winning, conversion rates per variant, and Beta distribution parameters.

no parameters
get_triggerread

Get full trigger configuration: events, dormancy, identifier type, destinations, payload templates.

1 parameter
ParameterTypeDescription
trigger_id
required
stringTrigger ID
get_trigger_templateread

Get full details of a trigger payload template.

1 parameter
ParameterTypeDescription
template_id
required
stringTemplate ID
get_zonesread

Get personalization zones. Pass zone_id to fetch a single zone (recommended when working on a specific zone — full response is 200KB+). Without zone_id, returns all zones for the site.

1 parameter
ParameterTypeDescription
zone_id
optional
stringIf provided, return only this zone (much smaller response — use this when repairing a specific zone's field_schema)
list_campaignsread

List all campaigns for the site with status and briefs.

no parameters
list_formsread

List reusable lead-capture form templates for this site. Each has a name and a payload (title, cta_text, tcpa_text, accent_color, fields[], calendar_enabled).

no parameters
list_lightbox_presetsread

List the canned lightbox display-rule presets (Welcome offer, Exit intent newsletter, Cart recovery, Promo bar, Returning visitor offer). Each preset returns a complete DisplayRules object that can be passed verbatim as create_zone.display_rules or update_zone.display_rules. Use this instead of authoring the rules JSON from scratch unless you need a custom combination.

no parameters
list_page_configsread

List page type configurations (product, category, blog).

no parameters
list_trigger_firesread

Get the audit log of fire attempts for a trigger: successes, errors, skipped fires with skip_reason.

2 parameters
ParameterTypeDescription
trigger_id
required
stringTrigger ID
limit
optional
numberMax rows (default 100, max 500)
list_trigger_templatesread

List available payload templates: system seeds and site-owned custom templates.

no parameters
list_triggersread

List all triggered messages for the site with watch event, mode, destinations, and enabled status.

no parameters
place_lead_formwrite

Deploy a lead-capture form onto a page: creates a lead_form content variant bound to a zone (anchor) + audience. The form INSERTS relative to the anchor by `position` (default "after" — slots between sections without taking over). Target ONE segment via `segment_id`, OR set `all_visitors: true` to show the form to EVERYONE regardless of segment (provide exactly one). Get a payload from list_forms (copy-on-place) or pass one directly. To anchor somewhere that is not yet a zone, call extension_pick_element then create_zone first.

5 parameters
ParameterTypeDescription
zone_id
required
stringAnchor zone to place the form relative to
segment_id
optional
stringAudience segment to show it to. Omit when all_visitors is true.
all_visitors
optional
booleanShow the form to ALL visitors regardless of segment. When true, omit segment_id.
payload
required
objectForm design payload (e.g. from a template via list_forms)
position
optional
"after" | "before" | "inside_start" | "inside_end" | "replace"Where the form inserts relative to the anchor element. Default "after". "replace" takes over the anchor (legacy / dedicated containers).
restore_content_variantwrite

Restore a content variant. Two modes: (1) pass only variant_id to un-delete a soft-deleted variant; (2) also pass version to roll back the payload to a specific historical version (use get_content_history to find version numbers). Restoring to a version is itself snapshotted, so you can always roll forward again.

2 parameters
ParameterTypeDescription
variant_id
required
stringVariant ID to restore
version
optional
integerHistory version to restore payload to. Omit to only un-delete.
suggest_donation_amountsread

Return the segment-aware donation ask ladder for a donor — the amounts a fundraising form should show first, plus the recurrence default + rationale. Pass `segment_suffix` for the default ladder per segment (e.g. "donor_ready", "high_capacity_uncontacted", "lapsed_quarterly"), OR pass `profile_id` to personalise off the donor's CRM-fed attributes (last_gift_amount_cents / recurring_amount_cents / lifetime_giving_cents / capacity_score). When `profile_id` is given without `segment_suffix`, the profile's current segment is used. Returns { ladder: { amounts_cents, recurrence, rationale, highlight_index?, highlight_label? }, resolved }. Amounts are in CENTS. Use before authoring a copy_swap variant that writes the amounts onto a donation form, or when the agent needs to suggest "what should we ask for" from the donor context.

6 parameters
ParameterTypeDescription
segment_suffix
optional
stringverticals.ts segment suffix (e.g. donor_ready, high_capacity_uncontacted, lapsed_quarterly).
profile_id
optional
stringProfile to personalise off — last gift, recurring amount, capacity. CRM attributes pulled from profiles.attributes.
last_gift_amount_cents
optional
integerOverride (cents). Useful when profile data is stale or unavailable.
recurring_amount_cents
optional
integerOverride (cents). For recurring_card_declined the ladder surfaces ONLY this amount.
lifetime_giving_cents
optional
integerOverride (cents). Elevates the high-capacity ladder when ≥ $10k.
capacity_score
optional
numberOverride (0..1). Elevates the high-capacity ladder when ≥ 0.9.
test_fire_triggerwrite

Fire a trigger against a test target, bypassing cooldown/rate limits. Goes through the real dispatch pipeline — WILL send real email/SMS.

4 parameters
ParameterTypeDescription
trigger_id
required
stringTrigger ID
profile_id
optional
stringProfile ID
identifier
optional
objectTest target identifier
event_properties
optional
objectOverride event properties
update_campaignwrite

Update a campaign name, brief, or status.

8 parameters
ParameterTypeDescription
campaign_id
required
stringCampaign ID
name
optional
string
brief
optional
object
status
optional
"active" | "draft" | "paused" | "archived"
starts_at
optional
string | null
ends_at
optional
string | null
eligibility
optional
object | null
priority
optional
number
update_content_variantwrite

Update a content variant payload or active status. A history snapshot of the previous state is automatically saved before the update, so changes are always reversible via restore_content_variant.

8 parameters
ParameterTypeDescription
variant_id
required
stringVariant ID
payload
optional
objectUpdated payload
active
optional
booleanEnable/disable
type
optional
"overlay" | "hero_swap" | "copy_swap" | "product_reco" | "move_object"
eligibility
optional
object
priority
optional
number
segment_id
optional
string
campaign_id
optional
string | null
update_formwrite

Update a form template name and/or payload.

3 parameters
ParameterTypeDescription
id
required
stringForm template ID
name
optional
stringNew name
payload
optional
objectUpdated form design
update_page_configwrite

Update a page type configuration.

3 parameters
ParameterTypeDescription
config_id
required
stringConfig ID
url_pattern
optional
stringUpdated URL pattern
selectors
optional
objectUpdated selectors
update_triggerwrite

Update an existing trigger. Pass only the fields to change.

15 parameters
ParameterTypeDescription
trigger_id
required
stringTrigger ID
name
optional
string
description
optional
string
enabled
optional
boolean
mode
optional
"immediate" | "dormancy"
watch_event
optional
string
cancel_event
optional
string
criteria
optional
object
delay_ms
optional
number
window_ms
optional
number
identifier_type
optional
string
destinations
optional
object[]
cooldown_per_profile_ms
optional
number
global_rate_limit_per_min
optional
number
optimization_mode
optional
"axo_bandit" | "external"Optimization mode
update_trigger_templatewrite

Update a site-owned trigger payload template.

6 parameters
ParameterTypeDescription
template_id
required
stringTemplate ID
name
optional
string
description
optional
string
format
optional
"json" | "html" | "form"
body
optional
string
example_destination
optional
string
update_zonewrite

Update an existing zone (selector, name, priority, approval, display_rules, or field schema). To add a missing field (e.g. image_url): call get_zones(zone_id) first to read the existing field_schema, then pass the full updated array with the new entry appended.

7 parameters
ParameterTypeDescription
zone_id
required
stringZone ID
display_name
optional
string
element_selector
optional
string
approved
optional
boolean
priority
optional
number
display_rules
optional
objectLightbox display rules — same shape as create_zone.display_rules. Send the full object to overwrite; omit to leave unchanged. Sanitized at the API.
field_schema
optional
object[]Full replacement field schema — pass the complete array including existing entries you want to keep. Read the current schema first with get_zones(zone_id).

Content variants

Draft, edit, and version the content served into zones.

get_contentread

Get content variants. Pass zone_id to fetch only variants for a single zone (recommended — the full response is 1MB+). Without zone_id, returns all variants for the site.

1 parameter
ParameterTypeDescription
zone_id
optional
stringIf provided, return only variants for this zone (much smaller response — use this when working on a specific zone)
get_content_historyread

Get the version history for a content variant. Returns up to 20 snapshots ordered newest first, each with version number, who changed it (api or dashboard), when, and the full payload. Use this before calling restore to find the version you want.

1 parameter
ParameterTypeDescription
variant_id
required
stringVariant ID to inspect
list_content_sourcesread

List captured content-backlog sources for the blog pipeline. Filter by status (new/used/skipped) and recency.

2 parameters
ParameterTypeDescription
status
optional
"new" | "used" | "skipped"Default: new
days
optional
numberLook-back window in days (default 30)
log_articlewrite

Log an interesting article, link, or point of view into the content backlog. The weekly blog pipeline drafts posts from these. Provide a url and/or a note explaining why it matters.

4 parameters
ParameterTypeDescription
url
optional
stringLink to the article/source (optional if note is given)
title
optional
stringTitle of the article (optional)
note
optional
stringYour angle: why this is interesting, what point it supports (optional if url is given)
tags
optional
string[]Freeform tags, e.g. ["agentic", "segmentation"]

Catalog & recommendations

Import products, manage the taxonomy, and configure recommendation zones.

get_catalog_import_statusread

Get the status and list of imported products in the catalog.

no parameters
get_site_taxonomyread

Retrieve the parsed taxonomy mapping representing the site hierarchy.

no parameters
import_catalogwrite

Import a payload of products into the product catalog.

1 parameter
ParameterTypeDescription
products
required
object[]Array of products to import
list_productsread

Search and list catalog products/items for a site. Allows filtering by category, specific product IDs, or including ignored items.

4 parameters
ParameterTypeDescription
ids
optional
string[]Array of specific product IDs to fetch (optional)
category
optional
stringFilter by category (optional)
include_ignored
optional
booleanIf true, include ignored products in the output (default false)
limit
optional
numberMax results (default 100, max 500)
list_taxonomy_termsread

List the site's taxonomy terms — the brand/topic/category vocabulary that drives per-visitor interest/affinity scoring. Optionally filter by dimension.

1 parameter
ParameterTypeDescription
dimension
optional
"brand" | "topic" | "category"Filter to one dimension
merge_categorieswrite

Merge and rename product categories (renames a category across all products in sitemap and page profiles).

2 parameters
ParameterTypeDescription
old_category
required
stringCurrent category name to rename
new_category
required
stringNew category name
reclassify_catalog_itemread

Change a catalog product/item details (category, name, brand, description, sku, price) or mark it as ignored (which hides it from the personalization catalog and excludes it from variant recommendation). Sets is_override to true.

8 parameters
ParameterTypeDescription
item_id
required
stringCatalog product UUID
category
optional
stringNew category name (optional)
name
optional
stringNew product name (optional)
brand
optional
stringNew brand name (optional)
description
optional
stringNew product description (optional)
sku
optional
stringNew SKU (optional)
price
optional
stringNew price (optional)
ignored
optional
booleanSet to true to ignore the product, false to restore (optional)

Assets & brand

Generate images, manage the DAM, and extract brand guidelines.

extract_brand_guidelineswrite

Extract brand features (colors, theme configurations) directly from the live homepage.

no parameters
generate_imagewrite

Generate a NEW image via the site's BYOK image provider (gemini | openai | firefly). Real, paid API call (~$0.04) — call search_assets FIRST and reuse an existing asset when one matches. provider + prompt required. Optional: model, width, height, negative_prompt; use_brief prepends brand-voice + active-campaign context; zone_key / variant_type add visual context; reference_images (catalog product / URL / data URL) and plan_with_claude require experimental_creative_enabled. When experimental_generative_dam_enabled is on, the image is persisted and the result carries asset_id + blob_url — pass that asset_id to attach_asset_to_variant to place it on a variant. The base64 data_url is OMITTED from the result (too large); fetch blob_url for the bytes.

11 parameters
ParameterTypeDescription
provider
required
"gemini" | "openai" | "firefly"BYOK provider. The site must have active credentials saved for it.
prompt
required
stringWhat to generate (max 4000 chars).
model
optional
stringOptional provider model id (e.g. "imagen-4.0-generate-001", "gpt-image-1"). Omit for the provider default.
width
optional
integerOptional pixel width.
height
optional
integerOptional pixel height.
negative_prompt
optional
stringOptional — things to avoid in the image.
use_brief
optional
booleanWhen true, prepend brand voice + active campaign brief context. Default false.
zone_key
optional
stringOptional zone hint (e.g. "hero") woven into the prompt.
variant_type
optional
stringOptional variant-type hint (overlay | hero_swap | copy_swap).
reference_images
optional
object[]Optional reference images (subject/style). Requires experimental_creative_enabled.
plan_with_claude
optional
booleanWhen true, Claude drafts a detailed shot prompt before dispatch. Requires experimental_creative_enabled. Default false.
get_assetread

Fetch one DAM asset by id — includes the full generation_metadata (user_prompt, enriched_prompt, brief / reference / planner attribution) and tags. Use to inspect an image's provenance before re-using or attaching it. search_assets returns the list view (no generation_metadata); this is the detail view.

1 parameter
ParameterTypeDescription
asset_id
required
stringAsset id (asset_<uuid> shape).
import_figma_brandwrite

Import and configure site brand definitions from a Figma file URL.

1 parameter
ParameterTypeDescription
figma_url
required
stringURL to the Figma file/component
list_dam_connectionsread

List the customer's DAM connections (Cloudinary, S3-compatible, etc.) for this site — masked credentials, active flag, provider metadata. Use before search_dam to discover which DAMs are wired (or to confirm one is connected before suggesting search_dam to the operator). Returns { connections: [{ id, provider, provider_meta, config_preview, active, ... }] }; credentials in config_preview are masked (api_secret as "••••XXXX"). Empty array when no DAM is connected.

no parameters
list_image_gen_keysread

List BYOK image-gen provider credentials for this site (Gemini, OpenAI, Adobe Firefly). The generate_image tool routes through whichever has saved credentials + provider matches the request. Use to discover which providers are available before suggesting generate_image, or to confirm a custom_model_id (BYOM) is set on a connection. Returns { keys: [...] } with masked credentials.

no parameters
list_text_gen_keysread

List BYOM text-gen credentials for this site (OpenAI-compatible endpoints — vLLM, Ollama, Azure OpenAI, LM Studio). When a key is active AND experimental_byom_enabled is on, /api/content/draft routes the variant-authoring AI calls through it instead of platform Anthropic. Use to discover whether the operator has BYOM text wired before suggesting draft_content_variant. Returns { keys: [...] } with masked api_key fields.

no parameters
register_dam_assetread

Create an AXO thin asset record from a brand-DAM asset (e.g. one returned by search_dam). Returns { id, url, reused } — the id is the asset_<uuid> you pass to attach_asset_to_variant. Dedups by (site_id, dam_provider, dam_asset_id) so picking the same asset twice reuses the existing row. No bytes pass through AXO; the asset stays in the customer's DAM. Gated on experimental_byo_dam_enabled + an active connection for the named provider.

7 parameters
ParameterTypeDescription
provider
required
stringVendor id from the search_dam hit ("cloudinary" | "s3_compatible").
dam_asset_id
required
stringVendor-side id from the hit (Cloudinary public_id, S3 key).
external_url
required
stringPublic URL from the hit (Cloudinary secure_url, S3 public URL).
mime_type
optional
stringOptional, defaults to image/png.
width
optional
numberOptional pixel width.
height
optional
numberOptional pixel height.
name
optional
stringOptional display name for the AXO library. Defaults to the asset id.
search_assetsread

Search the generative DAM asset library for previously-generated images. Filters: q (text match on name + prompt, ILIKE), subject (tags.subject exact), theme (tags.themes contains), provider (gemini|openai|firefly), include_archived (default false). Returns up to `limit` assets with their blob_url, name, prompt, provider/model, and auto-tagged subject/scene/themes/palette. Use this BEFORE generating new images — if the operator asks for "a warm autumn kitchen background" and one already exists in the library, attaching it saves $0.04 of generation cost and ~3 seconds of wall-clock. Requires experimental_generative_dam_enabled on site_config.product_catalog.

6 parameters
ParameterTypeDescription
q
optional
stringText match against name + prompt (ILIKE).
subject
optional
stringExact match on tags.subject (e.g. "kitchen").
theme
optional
stringTag in tags.themes (e.g. "minimalist").
provider
optional
"gemini" | "openai" | "firefly"
include_archived
optional
boolean
limit
optional
integerDefault 20.
search_damread

Search the customer's CONNECTED brand DAM (Cloudinary, S3-compatible) for assets — including ones the brand team uploaded directly without going through AXO. Use when the brand owns assets you want to BIND to a variant rather than generate fresh: the brand has approved imagery you should reuse. q matches filename + public_id + tag values (Cloudinary) or key-substring (S3); folder scopes to a folder prefix; tags filters to assets carrying ALL of the listed tags (Cloudinary only — S3 tags aren't indexed for search). Returns hits with asset_id (vendor public_id / S3 key), external_url, mime_type, tags, folder. THREE-STEP BIND FLOW: search_dam → register_dam_asset (creates AXO thin record + returns asset_id) → attach_asset_to_variant (binds to a variant field with provenance). Returns empty when no DAM is connected — search_assets handles the AXO-side library separately.

5 parameters
ParameterTypeDescription
q
optional
stringFree-text query — matched against filename, public_id, and tag values.
folder
optional
stringRestrict to a folder/prefix (e.g. "axo/franken-store-com").
tags
optional
string[]Restrict to assets carrying ALL of these tags (Cloudinary only — S3 ignores).
limit
optional
numberDefault 30, max 100.
provider
optional
stringOptional provider scope ("cloudinary" | "s3_compatible"). When omitted, uses the site's first active DAM connection.
update_assetwrite

Update a DAM asset: rename (name), replace its tags (tags object), or archive/unarchive (archived). Pass archived:true to soft-delete — it disappears from search_assets but any variant already pointing at its blob_url keeps working; archived:false restores it. At least one of name | tags | archived must be set. The blob bytes are never mutated.

4 parameters
ParameterTypeDescription
asset_id
required
stringAsset id (asset_<uuid> shape).
name
optional
stringNew display name (max 200 chars).
tags
optional
objectReplacement tags object. Overwrites the existing tags.
archived
optional
booleantrue to archive (soft-delete / hide from search), false to restore.

Integrations & sync

Connect destinations, test them, and sync CRM/Salesforce data.

create_integrationwrite

Create a new integration (klaviyo, braze, resend, webhook, meta_capi, google_ec).

4 parameters
ParameterTypeDescription
type
required
stringIntegration type
config
required
objectConfig (API keys, endpoints)
events
optional
string[]Events to fire on
active
optional
booleanEnable immediately
delete_integrationadmin

Delete an integration permanently.

1 parameter
ParameterTypeDescription
integration_id
required
stringIntegration ID
get_integrationread

Get full config for a single integration.

1 parameter
ParameterTypeDescription
integration_id
required
stringIntegration ID
get_integration_logsread

Recent fire log for an integration with success/error stats.

2 parameters
ParameterTypeDescription
integration_id
required
stringIntegration ID
limit
optional
numberMax rows (default 50)
list_integrationsread

List all integrations (Klaviyo, Braze, Resend, webhooks, CAPI) with status.

no parameters
sync_crmwrite

Push CRM records to enrich visitor profiles. Matches by email, phone, or external_id. Attributes (ltv, plan, customer_tier, etc.) are merged into the matched profile.

2 parameters
ParameterTypeDescription
records
required
object[]Array of CRM records to sync (max 1000)
source
optional
stringSource label (e.g. "salesforce", "hubspot")
test_integrationwrite

Send a test payload to an integration to verify the connection works.

1 parameter
ParameterTypeDescription
integration_id
required
stringIntegration ID
update_integrationwrite

Update integration config, events, or active status.

4 parameters
ParameterTypeDescription
integration_id
required
stringIntegration ID
config
optional
object
events
optional
string[]
active
optional
boolean

Site & configuration

Site config, verticals, taxonomy, sitemap health, and page configs.

analyze_sitemapread

Analyze a semantic sitemap structure to optimize category mapping internally.

1 parameter
ParameterTypeDescription
options
optional
objectConfiguration/tuning options for the analysis run
apply_vertical_packwrite

Apply (or re-apply) a vertical pack to the current site. Seeds any missing segments, zones, and variants from the pack and updates the site vertical. Idempotent — existing items are preserved.

1 parameter
ParameterTypeDescription
vertical
required
"ecommerce" | "home_services" | "saas" | "financial" | "healthcare" | "nonprofit"
define_affinity_termsread

Create or update taxonomy terms (brand/topic/category) with the keyword + URL-pattern rules that map pages to that object. These feed per-visitor affinity scoring and the "Interest / affinity" segment leaf. object_key defaults to a slug of the label. Example term: { dimension:"brand", label:"Titleist", keywords:["titleist"], url_patterns:["/titleist"] }.

1 parameter
ParameterTypeDescription
terms
required
object[]Terms to upsert
discover_sitemapwrite

Discover and map semantic URLs from the site, identifying structure automatically.

1 parameter
ParameterTypeDescription
url
optional
stringForce extraction starting from a specific URL
get_site_configread

Get current site configuration: brand, mode, conversion goal, settings.

no parameters
get_vertical_packread

Get the full contents of a vertical pack (segments, zones, variants) before applying it.

1 parameter
ParameterTypeDescription
vertical
required
"ecommerce" | "home_services" | "saas" | "financial" | "healthcare" | "nonprofit"
list_verticalsread

List available industry vertical packs (ecommerce, home_services, saas, financial, healthcare, nonprofit). Each pack bundles default segments, zones, and variants tailored to that industry.

no parameters
update_site_configwrite

Update site settings: brand, mode, conversion goal(s), zone overlap mode, holdout, passive_mode. Pass `goals` (array) to set the typed multi-goal list — primary + optional supporting goals. `conversion_goal` (single URL string) is the legacy single-goal field; passing it materializes a primary URL-kind goal. Pass one OR the other, not both. `passive_mode: true` locks out first-party PII (no lead forms, no identify/CRM writes) while keeping anonymous behavioral + goal/conversion tracking — use for no-PII pilots.

10 parameters
ParameterTypeDescription
mode
optional
"active" | "backtest"
conversion_goal
optional
string
goals
optional
object[]
brand_primary
optional
string
brand_accent
optional
string
brand_font
optional
string
zone_overlap_mode
optional
"all" | "first" | "priority"
disable_holdout
optional
boolean
holdout_pct
optional
integer
passive_mode
optional
boolean

CRM & pipeline

Manage the customer-facing sales pipeline: opportunities, contacts, tasks.

get_crm_statusread

Get CRM sync history and enrichment statistics. Shows how many profiles have CRM attributes, total enrichment coverage, and recent sync logs.

no parameters
get_salesforce_statusread

Get Salesforce integration status, sync history, and coverage stats. Shows connection state, recent syncs, and how many profiles are enriched from Salesforce.

no parameters
pipeline_add_contactwrite

Add a contact (name, email, phone, role) to a CRM opportunity. Set is_primary to make them the headline contact.

6 parameters
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
name
required
stringContact full name
email
optional
stringEmail address
phone
optional
stringPhone number
role
optional
stringRole, e.g. "Owner"
is_primary
optional
booleanMake this the primary contact
pipeline_add_notewrite

Append a note to a CRM opportunity's activity timeline (append-only): call summaries, next steps, observations.

2 parameters
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
body
required
stringThe note text (max 10k chars)
pipeline_add_taskwrite

Add a task (next step) to a CRM opportunity: "send the quote", "follow up Friday". Every open deal should have a next step — the earliest-due open task shows as the deal's next step on the board and in the digest. due_date is day-granular.

4 parameters
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
title
required
stringWhat needs doing, imperative, ≤200 chars — e.g. "Send revised quote"
due_date
optional
stringYYYY-MM-DD (omit for undated)
body
optional
stringOptional detail / context
pipeline_create_opportunitywrite

Create a CRM opportunity. Stage must be a key from pipeline_get_funnel (omit for the first open stage). value_cents is the deal value in cents. custom carries values for the account's defined custom fields (see settings.fields).

9 parameters
ParameterTypeDescription
company
required
stringCompany / customer name
title
optional
stringDeal title (default: "<company> deal")
stage
optional
stringFunnel stage key (default: first open stage)
value_cents
optional
numberDeal value in cents
website
optional
stringCompany website URL
source
optional
stringWhere the deal came from
notes
optional
stringFree-form notes
expected_close_date
optional
stringYYYY-MM-DD
custom
optional
objectCustom-field values keyed by the defs in settings.fields
pipeline_get_funnelread

The account's CRM pipeline definition: ordered stages (key, label, open/won/lost kind, close probability, stale_after_days) plus module settings (auto_create_from_leads, lost_reasons, fields, digest, …) and a vertical preset (suggested stages/lost reasons/fields for the account's business type — a seed to offer, never auto-applied). Call this FIRST before creating or moving opportunities — stage keys are per-account vocabulary, not a fixed set.

no parameters
pipeline_get_opportunityread

One CRM opportunity in full: fields, firmographic enrichment, contacts, tasks, and the activity timeline. Contacts and the company carry live on-site behavioral context — segments, interests/affinities (brand/topic/category), high-intent page signals, sessions, conversions, recency, and hotness — plus a rollup of other open deals at the same company domain.

1 parameter
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
pipeline_list_opportunitiesread

List the account's CRM opportunities (max 500, newest first) with stage, value, primary contact, hot-lead flag — plus the funnel stages for grouping into a board view.

no parameters
pipeline_list_prospectsread

Shadow opportunities ("Companies on your site"): corporate-email domain clusters of identified visitors whose behavior crossed the intent threshold, with evidence (people, sessions this week, top pages). These are deal CANDIDATES AXO observed — not yet in the pipeline. To ratify one, show it to the user and create an opportunity with pipeline_create_opportunity (company from the domain, contacts from the people, source "axo_prospect"). Domains already on open/won deals and dismissed domains are excluded.

no parameters
pipeline_list_tasksread

List CRM tasks (next steps) across the account's opportunities, earliest-due first. Default: open tasks only. Use due_before with today's date to find overdue tasks, or opportunity_id to see one deal's list. An open deal with no open task has "no next step" — worth flagging to the user.

3 parameters
ParameterTypeDescription
status
optional
stringopen|done|skipped|all (default open)
opportunity_id
optional
stringNarrow to one opportunity (opp_…)
due_before
optional
stringYYYY-MM-DD — only tasks due strictly before this date (overdue scan)
pipeline_log_activitywrite

Log a touchpoint (email, call, or meeting) on a CRM opportunity's timeline. Use external_ref (e.g. "gmail:<message-id>", "gcal:<event-id>") for idempotency — re-logging the same ref returns the existing row instead of duplicating, so sweep agents can re-run safely. For plain observations use pipeline_add_note; for inferred stage moves use pipeline_suggest_stage_move.

5 parameters
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
kind
required
stringemail|call|meeting
body
required
stringWhat happened — summary shown on the timeline (max 10k chars)
occurred_at
optional
stringWhen it happened, ISO 8601 (defaults to now; stored in metadata)
external_ref
optional
stringIdempotency key, e.g. "gmail:189ab…" — strongly recommended for swept sources
pipeline_propose_funnelwrite

Turn a plain-language description of how the business sells into a validated pipeline proposal: stages with probabilities, settings, and a rationale. READ-ONLY — returns the proposal plus the current stages for diffing; nothing is saved. Apply with pipeline_set_funnel after the user approves. Uses an AI call (allowance-metered).

1 parameter
ParameterTypeDescription
description
required
stringThe user's plain-language description of their sales process (10-4000 chars)
pipeline_set_funnelwrite

Save the account's CRM pipeline: stages replace wholesale, settings merge per key (a single knob never wipes the others). Stage validation: 3-12 stages, snake_case keys, exactly one won + one lost stage, probabilities 0-100, optional stale_after_days (1-365, open stages) for the stale-deal nudge; a stage currently holding opportunities cannot be removed (move them first). Omit stages to change settings alone.

4 parameters
ParameterTypeDescription
stages
optional
object[]The complete ordered stage list — replaces the existing funnel wholesale; omit to keep the current ladder and only touch settings
auto_create_from_leads
optional
booleanWhen true, captured website leads auto-create/attach opportunities. Omit to leave unchanged.
lost_reasons
optional
string[]Lost-reason vocabulary (max 12, each ≤40 chars) — powers the picker and the "why we lose" grouping; deals can still record any free-text reason. Omit to leave unchanged.
fields
optional
object[]Custom-field definitions for opportunities (max 10); money = integer cents; options required for select. Omit to leave unchanged.
pipeline_suggest_stage_movewrite

Propose (not perform) a stage move on a CRM opportunity: appends a suggestion the user accepts or dismisses in the CRM. USE THIS whenever you INFER a deal progressed — pipeline_update_opportunity is only for user-directed moves.

3 parameters
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
to_stage
required
stringThe proposed funnel stage key
reason
required
stringThe evidence, 1-3 sentences — shown verbatim on the timeline
pipeline_update_opportunitywrite

Update a CRM opportunity — move stage (auto-logs a stage_change and fires the behavioral rail), change value, title, close date, custom fields, or record a lost_reason. Only pass changed fields. IMPORTANT: only move stages when the user asked for the move or approved a suggestion; when you merely INFER progress, use pipeline_suggest_stage_move instead. When moving a deal to the lost stage, ask for (or infer from the user's words) a short lost_reason.

11 parameters
ParameterTypeDescription
opportunity_id
required
stringThe opportunity id (opp_…)
stage
optional
stringNew funnel stage key
company
optional
stringCompany name
title
optional
stringDeal title
value_cents
optional
numberDeal value in cents
website
optional
stringCompany website URL
source
optional
stringDeal source
notes
optional
stringFree-form notes (replaces existing)
expected_close_date
optional
stringYYYY-MM-DD
lost_reason
optional
stringWhy the deal was lost, ≤80 chars — free text; prefer one of settings.lost_reasons when it fits. Only settable on a deal in (or moving to) the lost stage; cleared on reopen.
custom
optional
objectCustom-field values to merge (null deletes a key), keyed by the defs in settings.fields
pipeline_update_taskwrite

Update a CRM task: complete it (status done), skip it, reopen it, reschedule (due_date), or edit the title/body. Completing or skipping logs a system activity on the deal's timeline.

5 parameters
ParameterTypeDescription
task_id
required
stringThe task id (task_…)
status
optional
stringopen|done|skipped
title
optional
stringNew title
body
optional
stringNew detail (empty string clears)
due_date
optional
stringNew due date YYYY-MM-DD (empty string clears)
trigger_salesforce_syncwrite

Trigger a Salesforce sync. Direction can be outbound (push AXO→SF), inbound (pull SF→AXO), or bidirectional.

1 parameter
ParameterTypeDescription
direction
optional
"outbound" | "inbound" | "bidirectional"Sync direction (default: uses configured direction)