Tool reference

Sentway MCP tool reference

Sentway exposes 57 tools over MCP. This index and every tool page below are generated directly from the running server, so the parameters listed here are the parameters the server accepts.

Getting started

Sites

  • list_sites

    list_sites: List sites in the current Sentway account, newest-created first.

  • get_site

    Return one Sentway site's slim overview: site identity and status, selected draft-or-published page count, total version count, access-mode summary, and the latest persisted draft block summary when present.

  • create_site

    Create a new draft site for the caller's account and return the generated subdomain slug plus its canonical public_url.

Pages

  • list_pages

    List the selected draft-or-published pages for one Sentway site.

  • get_page

    Return one page from the selected draft-or-published version of a Sentway site by path, including its stored source.

  • save_page

    Author or replace a single page in the site's current draft, opening a draft from the published version if none exists.

  • patch_page

    Literal find/replace edits on a draft page (auto-opens from published).

  • remove_page

    Remove a single page from the site's current draft, opening a draft from the published version if the path only exists there.

Publishing

  • list_versions

    List every version of one Sentway site, newest-created first, with status, label, timestamps, page count, and whether it is the site's current published version.

  • render_page

    JPEG screenshot of a published page as an image content block plus metadata.

  • publish_site

    Promote the site's current draft to a new published version and return the report.

Access and gates

  • get_gate_design

    Return the site's published and draft gate design cells (draft is null when none is in flight), whether unpublished changes exist, a compact theme summary, and a short-lived preview URL when a signing secret is configured and the gate is not public.

  • get_paid_access

    Return the site's paid access configuration: Stripe readiness, every offer (title, GBP pence price, status, protection scope, locked paths, buyer_audience, access_days or null for lifetime plus access_until for legacy fixed-expiry offers), the site's page paths, the paths protected in the published snapshot, the gate now versus after the next publish, and whether a publish is required.

  • get_paid_access_design

    Return the FULL-SCREEN paywall design for one SITE-WIDE offer (entire_site or except_homepage): the effective design, the stored cell (null when uncustomised), and the offer's title, price and currency.

  • get_paid_access_requirements

    Return one offer's BUYER REQUIREMENTS: who may buy by email ('none' or an approved-email allowlist with its entries), whether a purchase password is set, and the pre-checkout questions.

  • get_paid_modal_design

    Return the payment MODAL design for a selected_pages offer: the effective design, the stored cell (null when uncustomised), and the offer's title, price and currency.

  • get_paid_access_preview

    Return a short-lived URL rendering one offer's paywall as a buyer sees it, the surface it uses (gate for site-wide offers, modal for selected-page ones) and a render-safe summary of what the buyer is asked for.

  • get_site_access

    Start here before changing access: ONE unified view of the published gate, the gate the next publish will present, whether a publish is required, the stored classic gate, Stripe readiness, and every paid offer with its buyer_audience, scope, price, access length, design surface and buyer-requirement counts.

  • set_gate_access

    Choose the site's primary gate: public, email_capture, allowlist, password, or paid.

  • set_paid_accessPro

    Create or update one paid access offer (GBP only): omit offer_id to create, pass it to update.

  • set_paid_access_designPro

    Replace the FULL-SCREEN paywall design for one SITE-WIDE offer (FULL REPLACE, not a merge).

  • set_paid_access_requirementsPro

    Set who may BUY one offer and what they answer first.

  • set_paid_access_passwordPro

    Set or remove the PURCHASE password for one paid access offer: buyers must type it before Stripe Checkout opens.

  • set_paid_modal_designPro

    Replace the payment MODAL design for a selected_pages offer (FULL REPLACE, not a merge).

  • set_gate_draft_design

    Replace the site's DRAFT gate design without changing what visitors see (FULL REPLACE, not a merge).

  • publish_gate_design

    Promote the site's draft gate design to the live design so visitors see it.

  • discard_gate_draft

    Throw away the site's unpublished gate design draft and reset it to the published design.

  • upload_gate_asset_from_url

    Add a logo or background image to a site's gate and paywall design from a public https URL.

Assets

  • get_upload_result

    Poll an upload session by token.

  • search_assets

    Plain-text search of the account's asset library across name, description, tags and format (exact).

  • list_assets

    List the account's assets, newest first, with keyset pagination.

  • get_asset

    Fetch one asset by id.

  • request_asset_upload

    Mint an upload session and return the URL a human opens in a browser to attach files.

  • upload_asset_from_url

    Ingest an image asset from a public https URL: reachable without authentication, resolving to a public IP (SSRF guards), never a chat attachment.

  • update_asset_metadata

    Update name / description / tags on an existing asset.

  • delete_asset

    Permanently delete an asset, its bytes and thumbnail.

Analytics

  • get_submissions

    List one site's form submissions, newest first, with pagination totals and an optional form_key filter.

  • get_visitor_activityPro

    Return one visitor's interaction timeline for a site, newest first.

  • get_analytics

    Aggregate site metrics from the site_stats rollup for today | 7d | 30d | all: page_views, visitor_days, submissions_count, plan_completions, gate_passes, engaged_seconds, plus the resolved range and day_from (UTC date).

Responses and visitors

  • list_visitorsPro

    List visitors on one site (Pro).

  • list_plan_progressPro

    List action-plan task completion for one site, grouped by (visitor_id, plan_key).

  • list_worksheet_answersPro

    List worksheet answers for one site.

  • list_visitor_uploadsPro

    List one visitor's uploads.

  • list_site_uploadsPro

    List every visitor upload on one site.

  • get_visitorPro

    Return identity fields (first/last seen, email, verification, returning_gap) and rollup counters (submissions, plan_tasks_completed, worksheets, doc_uploads) for one visitor on one site.

  • erase_visitor

    Permanently erase one visitor: identity, submissions scrub, interactions, worksheets, uploaded documents (rows + Storage objects).

Site lifecycle

  • check_slug_available

    Check whether a subdomain slug is free for this account.

  • duplicate_site

    Duplicate a published site: copies its gate configuration and seeds the new site's draft from the source's published version.

  • archive_site

    Archive a site so it stops serving traffic.

  • restore_site

    Restore an archived site.

  • change_slug

    Change a site's subdomain slug.

  • delete_site

    Permanently delete a site and everything in it (pages, versions, interactions, submissions, this site's assets, gate configuration).

Payments and selling

  • get_seller_details

    Return the account's PUBLIC seller details shown to consumer buyers before payment: trading name, support email, trading address and the optional Terms and refund-policy links, plus complete and the missing required fields.

  • get_commerce_setup

    Return whether this account can actually take money: readiness (not_connected, onboarding_incomplete, restricted, test_ready, live_ready), per-mode Stripe Connect state (test and live: connected, status, charges_enabled, payouts_enabled, details_submitted, outstanding requirement count, country, currency), the plan and whether Pro is required, whether this credential may run onboarding, and whether the public seller details needed for consumer selling are complete.

  • set_seller_details

    Save the account's PUBLIC seller details used for consumer selling.

  • create_stripe_connect_linkPro

    Mint a short-lived Stripe-hosted onboarding link for this account's connected Stripe account, creating that account first if it does not exist.