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.
| Tool | Does |
|---|---|
list_sites | List sites and apps |
get_embed_snippet | Get the script tag for a web site |
list_walkthroughs | List a site’s tours |
get_walkthrough | Read a tour’s full config |
create_walkthrough | Create a tour |
update_walkthrough | Edit, publish or unpublish a tour |
delete_walkthrough | Delete an inactive tour |
get_styles | Read a site’s styles |
update_styles | Change a site’s styles |
get_analytics | Read 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.
| Field | Type | Default | Description |
|---|---|---|---|
site_id | string | required | From list_sites. |
list_walkthroughs
Lists a site’s tours with id, name, page_pattern, active and step_count.
| Field | Type | Default | Description |
|---|---|---|---|
site_id | string | required | From list_sites. |
get_walkthrough
Returns one tour’s full configuration: every step and every setting.
| Field | Type | Default | Description |
|---|---|---|---|
walkthrough_id | string | required | From 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.
| Field | Type | Default | Description |
|---|---|---|---|
site_id | string | required | The site to add it to. |
name | string | required | Internal name. |
steps | Step[] (≥ 1) | required | Each { selector, title, content }. |
page_pattern | string | "/" | /path exact, /path/* prefix, * every page — or a screen identifier for apps. |
fab_label | string | "Page guide" | Launcher label. |
welcome_emoji | string | "👋" | |
welcome_title | string | "Welcome!" | |
welcome_message | string | "Let us show you around." | |
active | boolean | false | true publishes immediately. |
welcome_mode | "full" | "button" | "full" | “button” skips the welcome card; the launcher starts the tour. |
welcome_cta_label | string | "Yes, show me around!" | Welcome card button. |
welcome_dismiss_label | string | "Don’t show again" | Welcome card dismiss link. |
auto_open | boolean | false | Open the welcome card ~1s after load. |
start_minimized | boolean | false | Launcher starts as an edge tab. |
auto_launch | boolean | false | Start the tour on load, skipping the welcome card. |
auto_launch_always | boolean | true | With auto_launch: every visit (true) or only the first auto_launch_count. |
auto_launch_count | integer ≥ 1 | 1 | Visits that auto-launch when auto_launch_always is false. |
max_shows | integer ≥ 1 | null | null | Cap on automatic shows per visitor. null = unlimited. |
display_conditions | object | null | null | See below. null clears all conditions. |
splash_carousel | object | null | null | See 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.
| Field | Type | Default | Description |
|---|---|---|---|
walkthrough_id | string | required | |
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_label | string | "Yes, show me around!" | Welcome card button. |
welcome_dismiss_label | string | "Don’t show again" | Welcome card dismiss link. |
auto_open | boolean | false | Open the welcome card ~1s after load. |
start_minimized | boolean | false | Launcher starts as an edge tab. |
auto_launch | boolean | false | Start the tour on load, skipping the welcome card. |
auto_launch_always | boolean | true | With auto_launch: every visit (true) or only the first auto_launch_count. |
auto_launch_count | integer ≥ 1 | 1 | Visits that auto-launch when auto_launch_always is false. |
max_shows | integer ≥ 1 | null | null | Cap on automatic shows per visitor. null = unlimited. |
display_conditions | object | null | null | See below. null clears all conditions. |
splash_carousel | object | null | null | See below. More and Too Many plans only. null removes the carousel. |
display_conditions object
{
"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
}splash_carousel object
{
"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.
| Field | Type | Default | Description |
|---|---|---|---|
walkthrough_id | string | required |
get_styles
Returns the site’s styles JSON.
| Field | Type | Default | Description |
|---|---|---|---|
site_id | string | required |
update_styles
Deep-merges changes into the styles, section by section — sections you don’t pass are untouched.
| Field | Type | Default | Description |
|---|---|---|---|
site_id | string | required | |
styles | object | required | e.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.
| Field | Type | Default | Description |
|---|---|---|---|
walkthrough_id | string | required | |
days | integer 1–90 | 30 | Look-back window. |