DocsAI & MCP

MCP tools reference

All ten tools the Tooltip Tour MCP server exposes, with every parameter.

The server exposes ten tools. Every tool only sees the account that connected. IDs come from the list tools.

ToolDoes
list_sitesList sites and apps
get_embed_snippetGet the script tag for a web site
list_walkthroughsList a site’s tours
get_walkthroughRead a tour’s full config
create_walkthroughCreate a tour
update_walkthroughEdit, publish or unpublish a tour
delete_walkthroughDelete an inactive tour
get_stylesRead a site’s styles
update_stylesChange a site’s styles
get_analyticsRead a tour’s event counts

list_sites

Lists the account’s sites: id, name, domain, type (web, ios, android, react-native) and site_key. No parameters.

get_embed_snippet

Returns the <script> tag for a web site plus install instructions. Errors for app sites, which use an SDK instead.

FieldTypeDefaultDescription
site_idstringrequiredFrom list_sites.

list_walkthroughs

Lists a site’s tours with id, name, page_pattern, active and step_count.

FieldTypeDefaultDescription
site_idstringrequiredFrom list_sites.

get_walkthrough

Returns one tour’s full configuration: every step and every setting.

FieldTypeDefaultDescription
walkthrough_idstringrequiredFrom list_walkthroughs.

create_walkthrough

Creates a tour. It’s created inactive unless active: true is passed. Fails if the account is at its plan’s walkthrough limit.

FieldTypeDefaultDescription
site_idstringrequiredThe site to add it to.
namestringrequiredInternal name.
stepsStep[] (≥ 1)requiredEach { selector, title, content }.
page_patternstring"/"/path exact, /path/* prefix, * every page — or a screen identifier for apps.
fab_labelstring"Page guide"Launcher label.
welcome_emojistring"👋"
welcome_titlestring"Welcome!"
welcome_messagestring"Let us show you around."
activebooleanfalsetrue publishes immediately.
welcome_mode"full" | "button""full"“button” skips the welcome card; the launcher starts the tour.
welcome_cta_labelstring"Yes, show me around!"Welcome card button.
welcome_dismiss_labelstring"Don’t show again"Welcome card dismiss link.
auto_openbooleanfalseOpen the welcome card ~1s after load.
start_minimizedbooleanfalseLauncher starts as an edge tab.
auto_launchbooleanfalseStart the tour on load, skipping the welcome card.
auto_launch_alwaysbooleantrueWith auto_launch: every visit (true) or only the first auto_launch_count.
auto_launch_countinteger ≥ 11Visits that auto-launch when auto_launch_always is false.
max_showsinteger ≥ 1 | nullnullCap on automatic shows per visitor. null = unlimited.
display_conditionsobject | nullnullSee below. null clears all conditions.
splash_carouselobject | nullnullSee below. More and Too Many plans only. null removes the carousel.

update_walkthrough

Changes only the fields you pass. Passing steps replaces the whole step list. active publishes or unpublishes. null clears nullable fields.

FieldTypeDefaultDescription
walkthrough_idstringrequired
name, page_pattern, steps, fab_label, welcome_*, active——As in create_walkthrough, all optional.
welcome_mode"full" | "button""full"“button” skips the welcome card; the launcher starts the tour.
welcome_cta_labelstring"Yes, show me around!"Welcome card button.
welcome_dismiss_labelstring"Don’t show again"Welcome card dismiss link.
auto_openbooleanfalseOpen the welcome card ~1s after load.
start_minimizedbooleanfalseLauncher starts as an edge tab.
auto_launchbooleanfalseStart the tour on load, skipping the welcome card.
auto_launch_alwaysbooleantrueWith auto_launch: every visit (true) or only the first auto_launch_count.
auto_launch_countinteger ≥ 11Visits that auto-launch when auto_launch_always is false.
max_showsinteger ≥ 1 | nullnullCap on automatic shows per visitor. null = unlimited.
display_conditionsobject | nullnullSee below. null clears all conditions.
splash_carouselobject | nullnullSee below. More and Too Many plans only. null removes the carousel.

display_conditions object

JSON
{
  "elementConditions": [
    { "selector": "[data-tour=\"plan\"]", "rule": "visible" }   // exists | not_exists | visible | not_visible
  ],
  "elementLogic": "and",                                         // and | or
  "priorTourConditions": [
    { "tourId": "<walkthrough id>", "rule": "completed" }        // seen | completed
  ],
  "priorTourLogic": "and",
  "deviceTarget": "desktop",                                     // all | mobile | desktop
  "dateRange": { "from": "2026-12-01", "to": "2026-12-31" }      // either bound optional
}
JSON
{
  "slides": [
    { "title": "Welcome", "description": "…", "imageUrl": "https://…", "logoUrl": "https://…" }
  ],
  "maxShows": 1    // per visitor; null = no limit
}

delete_walkthrough

Permanently deletes a tour. Refuses if the tour is live — deactivate it first with update_walkthrough. This can’t be undone.

FieldTypeDefaultDescription
walkthrough_idstringrequired

get_styles

Returns the site’s styles JSON.

FieldTypeDefaultDescription
site_idstringrequired

update_styles

Deep-merges changes into the styles, section by section — sections you don’t pass are untouched.

FieldTypeDefaultDescription
site_idstringrequired
stylesobjectrequirede.g. { "fab": { "bg_color": "#1925AA" }, "beacon": { "style": "ring" } }. Keys per the styles reference.

get_analytics

Event totals for one tour — guide_shown, guide_started, guide_completed, guide_abandoned — and step_viewed counts per step.

FieldTypeDefaultDescription
walkthrough_idstringrequired
daysinteger 1–9030Look-back window.
Something missing or unclear? Tell us and we’ll fix the page.