Skip to content

Tools reference ​

The Cashfin MCP server exposes 130 tools. Every tool declares what it does to your data, so your assistant can ask for confirmation before risky calls:

HintMeaningCount
readReads only. Never changes your storefront.29
writeCreates or updates drafts. Reversible in the builder, nothing goes live.78
destructiveDeletes data or publishes drafts live.23

Recommended approval settings

Allow read and write tools without asking, and keep destructive tools on ask. Your site stays safe while the assistant works quickly.

Tools are listed by area below. Each tool's full description and input schema are sent to your assistant when it connects; ask the assistant to explain any tool if you need its parameters.

Cashfin shop ​

Read your business and catalogue, set brand colours, scaffold shop pages and bind storefront actions. See Shop & catalogue.

ToolAccessDescription
bind_product_optionswriteBind product options. Make the product page you designed work: name your own layers by role and the variants, modifiers, quantity, stock, gallery and add-to-cart/buy-now buttons are wired to the live product exactly like…
get_shop_contextreadGet shop context. Read the Cashfin shop before any shop work: the business profile (name, logo, industry, contact, brand), bookings on/off, the currency, catalogue counts, the synced collections with their key field…
scaffold_shopwriteScaffold shop pages. Make sure the shop pages exist: /products (the catalogue), /products/* (the product page, bound to the Products collection) and /category/* (the category page, bound to Categories).
set_brand_palettewriteSet brand palette. Set the shop's brand colours.
set_storefront_actionwriteSet storefront action. Make a layer you built (usually a button) do a shop action on the published site: add to cart, buy now, go to cart/checkout, open the cart drawer (ui.toggle), start a booking or save to the wishlist.

Pages & redirects ​

Create, update and organise pages, and manage URL redirects.

ToolAccessDescription
add_redirectwriteAdd redirect. Add a new URL redirect.
create_pagewriteCreate page. Create a new page.
delete_pagedestructiveDelete page. Permanently delete a page and all its layers
delete_redirectdestructiveDelete redirect. Delete a redirect by ID.
duplicate_pagewriteDuplicate page. Create a copy of a page including all its layers.
get_pagereadGet page. Get a single page by ID, including its settings and metadata
list_pagesreadList pages. List all pages in the website with their IDs, names, slugs, and folder structure.
list_redirectsreadList redirects. List all configured URL redirects.
update_pagewriteUpdate page. Update a page's metadata: name, slug, folder, homepage flag, dynamic flag, and error-page assignment.
update_page_settingswriteUpdate page settings. Update page SEO, custom code, password protection, or CMS binding (dynamic pages).
update_redirectwriteUpdate redirect. Update an existing redirect by ID.

Page folders ​

Group pages into folders that shape your URLs.

ToolAccessDescription
create_page_folderwriteCreate page folder. Create a new page folder.
delete_page_folderdestructiveDelete page folder. Delete a page folder and all its contents (pages and sub-folders).
list_page_foldersreadList page folders. List all page folders with their hierarchy.
update_page_folderwriteUpdate page folder. Update a page folder name, slug, or settings.

Layers & elements ​

Read and edit the elements on a page: text, images, buttons, sections, and their design and settings.

ToolAccessDescription
add_layerwriteAdd layer. Add a new element to a page.
delete_layerdestructiveDelete layer. Remove a layer and all its children from a page
export_layer_htmlreadExport layer as HTML. Render a layer (and its descendants) to a self-contained HTML string with Tailwind classes preserved.
get_layersreadGet page layers. Get the layer tree for a page.
move_layerwriteMove layer. Move a layer to a different parent or position within the page tree
set_rich_text_contentwriteSet rich text content. Set the content of a richText layer using structured blocks.
update_form_settingswriteUpdate form settings. Configure how a form layer handles submissions.
update_layer_background_imagewriteUpdate layer background image. Set a background image on any layer in the Ycode editor (see https://docs.ycode.com) using an asset ID or URL.
update_layer_designwriteUpdate layer design. Update the visual design of a layer.
update_layer_iframewriteUpdate layer iframe. Set the source URL for an iframe layer in the Ycode editor (see https://docs.ycode.com).
update_layer_imagewriteUpdate layer image. Set the image source of an image layer on a PAGE using an asset ID (from upload_asset or list_assets).
update_layer_linkwriteUpdate layer link. Configure a link on any layer (button, div, text, image, etc.) in the Ycode editor (see https://docs.ycode.com).
update_layer_settingswriteUpdate layer settings. Update layer settings like HTML tag, custom ID, custom attributes, embed code, visibility, and per-element configuration (slider, carousel, lightbox, map, select options, filter, placeholder option).
update_layer_textwriteUpdate layer text. Update the text content of a text, heading, or button layer.
update_layer_videowriteUpdate layer video. Set the video source of a video layer in the Ycode editor (see https://docs.ycode.com).

Batch operations ​

Apply many edits in one call.

ToolAccessDescription
batch_operationswriteRun batch layer operations. Execute multiple layer operations in a single call.

Layout templates ​

Insert professionally designed sections from the layout catalogue.

ToolAccessDescription
add_layoutwriteAdd layout template. Insert a pre-built, fully-styled layout section into a page.
list_layoutsreadList layout templates. List all available pre-built layout templates organized by category.

HTML import ​

Turn HTML into native, editable Cashfin elements.

ToolAccessDescription
import_htmlwriteImport HTML as layers. Import HTML with Tailwind classes as native, editable Ycode layers in one call (see https://docs.ycode.com).

Layer styles ​

Reusable named styles that many elements can share.

ToolAccessDescription
apply_stylewriteApply style. Apply a single reusable layer style to a layer, replacing any existing style stack.
create_stylewriteCreate style. Create a reusable layer style — like a CSS class.
delete_styledestructiveDelete style. Delete a reusable layer style.
list_stylesreadList styles. List all reusable layer styles.
set_layer_styleswriteSet layer styles. Set the ordered stack of reusable styles applied to a layer (combo classes).
update_stylewriteUpdate style. Update a reusable layer style — change its name or design properties.

Rich-text styles ​

Typography for headings, paragraphs and lists inside rich text.

ToolAccessDescription
update_rich_text_styleswriteUpdate rich text element styles. Style the elements INSIDE rich text — every h2, paragraph, list, blockquote, link, image, table cell… rendered by a richText layer (including CMS rich_text fields bound to it).

Color variables ​

Site-wide colour tokens referenced as var(--id).

ToolAccessDescription
create_color_variablewriteCreate color variable. Create a new color variable (design token).
delete_color_variabledestructiveDelete color variable. Delete a color variable.
list_color_variablesreadList color variables. List all color variables (design tokens).
reorder_color_variableswriteReorder color variables. Reorder color variables by providing the full list of IDs in the desired order.
update_color_variablewriteUpdate color variable. Update a color variable name or value.

Fonts ​

Search Google Fonts and install fonts on the site.

ToolAccessDescription
add_fontwriteAdd font. Add a Google Font to the site.
delete_fontdestructiveDelete font. Remove a font from the site.
list_fontsreadList fonts. List all fonts added to the site.
search_google_fontsreadSearch Google Fonts. Search the Google Fonts catalog to discover available fonts.
update_fontwriteUpdate font. Update a font (change weights, variants, or category).

Components ​

Reusable blocks and their variants. Edit once, update everywhere.

ToolAccessDescription
add_component_instancewriteAdd component instance. Reuse a component on a PAGE by inserting a real component instance (a layer that references the component and shares its structure).
create_componentwriteCreate component. Create a new reusable component.
create_component_from_layerwriteCreate component from layer. Turn an existing PAGE layer (and its subtree) into a new reusable component, then replace it in place with an instance of that component.
create_component_variantwriteCreate component variant. Add a new named variant to a component.
delete_componentdestructiveDelete component. Delete a component.
delete_component_variabledestructiveDelete component variable. Delete a variable from a component and clean up every reference: unlink it from all of the component's variant layers, and remove any per-instance overrides that referenced it across pages.
delete_component_variantdestructiveDelete component variant. Delete a named variant.
detach_component_instancedestructiveDetach component instance. Detach a component instance on a PAGE, converting it back into plain, editable layers (a copy of the component's current structure with fresh IDs).
get_componentreadGet component. Get a component by ID: its variables and the layer tree of each variant (variants[0] is the primary variant; the first variant's tree is what instances render by default).
list_component_variantsreadList component variants. List the named variants of a component.
list_componentsreadList components. List all reusable components with their variables and where they are used.
reorder_component_variantswriteReorder component variants. Reorder a component's variants.
replace_component_instancesdestructiveReplace component instances site-wide. Swap EVERY instance of one component for another across all draft pages in one call (e.g.
replace_layer_with_componentwriteReplace layer with component. Swap an existing PAGE layer for a component instance in place (keeps its position).
set_component_instancewriteSet component instance overrides. Customize a component INSTANCE on a page: override per-instance content (text, image, link, icon, media, nested variant) and/or switch which variant the instance renders.
update_componentwriteUpdate component. Update a component's name and/or variables.
update_component_layerswriteUpdate component layers. Edit the inside of a component: add, remove, move, restyle, or set content on the layers within a component's tree (the master definition, not a page instance).
update_component_variantwriteUpdate component variant. Rename a component variant.

Animations & interactions ​

Entrance animations, presets and interactions.

ToolAccessDescription
add_animationwriteAdd animation. Add a curated animation to a layer using one of Cashfin Business's preset patterns.
clear_layer_animationsdestructiveClear layer animations. Remove all animations from a layer.
list_layer_animationsreadList layer animations. List all animations attached to a layer with their triggers and tween summaries.
remove_layer_animationdestructiveRemove layer animation. Remove a single animation from a layer by its interaction ID.
set_layer_interactionswriteSet layer interactions. Raw escape hatch: replace a layer's entire interactions array with the full LayerInteraction shape.

Assets ​

Images and files in the asset library.

ToolAccessDescription
delete_assetdestructiveDelete asset. Delete an asset from the library
get_assetreadGet asset. Get details of a single asset by ID
list_assetsreadList assets. List all assets in the library with their IDs, filenames, URLs, and dimensions
update_assetwriteUpdate asset. Update an asset (rename or move to a folder)
upload_assetwriteUpload asset. Upload an image to the Cashfin Business asset library.

Asset folders ​

Organise the asset library.

ToolAccessDescription
create_asset_folderwriteCreate asset folder. Create a new asset folder to organize images and files.
delete_asset_folderdestructiveDelete asset folder. Delete an asset folder and all assets within it.
list_asset_foldersreadList asset folders. List all asset folders.
update_asset_folderwriteUpdate asset folder. Rename an asset folder.

CMS collections ​

Collections, fields and items. Cashfin-synced catalogue collections are read-only.

ToolAccessDescription
add_collection_fieldwriteAdd collection field. Add a field to a collection's schema.
create_collectionwriteCreate collection. Create a new CMS collection.
create_collection_itemwriteCreate collection item. Create a new item in a collection.
delete_collectiondestructiveDelete collection. Delete a collection and all its fields, items, and values
delete_collection_fielddestructiveDelete collection field. Delete a field from a collection.
delete_collection_itemdestructiveDelete collection item. Delete an item from a collection
list_collection_itemsreadList collection items. List items in a collection with their field values.
list_collectionsreadList collections. List all CMS collections with their IDs, names, slugs, and default sorting.
reorder_collection_fieldswriteReorder collection fields. Reorder the fields of a collection.
set_collection_item_orderwriteSet collection item order. Set the manual ordering position of an item within its collection.
update_collectionwriteUpdate collection. Rename a collection or update its default sorting.
update_collection_fieldwriteUpdate collection field. Update a collection field (rename, change type, update reference, change metadata, update type-specific data).
update_collection_itemwriteUpdate collection item. Update field values for an existing collection item.

Collection lists ​

Show collection items on pages: binding, filters, visibility and dynamic text.

ToolAccessDescription
bind_collection_layerwriteBind collection list. Bind a Collection List element (add_layer template "collection") to a CMS collection so the layer itself (the card) repeats once per item.
bind_layer_fieldwriteBind layer to field. Bind a layer's content to a CMS collection field so it shows live data per item.
set_collection_filterswriteSet collection filters. Set the filters on a Collection List element so it only renders matching items (filtering at the data level, before render).
set_dynamic_textwriteSet dynamic text. Set a text layer's content to a mix of literal text and one or more CMS fields in a single text node (e.g.
set_layer_visibilitywriteSet layer visibility. Set conditional visibility on ANY layer: it only renders when the conditions match.

Collection pages ​

Generate a page per collection item.

ToolAccessDescription
create_collection_pageswriteCreate collection pages. Scaffold the pages a collection needs in one call: a folder (e.g.

Forms ​

Form settings and submissions.

ToolAccessDescription
delete_form_submissiondestructiveDelete form submission. Permanently delete a form submission.
get_form_submissionreadGet form submission. Get a single form submission by ID with full payload and metadata.
list_form_submissionsreadList form submissions. List submissions for a specific form, optionally filtered by status.
list_formsreadList forms. List all forms that have received submissions, with counts and latest submission date.
mark_all_submissions_readwriteMark all submissions read. Mark all new submissions for a form as read.
update_form_submission_statuswriteUpdate form submission status. Update the status of a form submission (e.g.

Localization ​

Locales and translations.

ToolAccessDescription
batch_set_translationswriteSet translations in batch. Create or update up to 1000 translations in one call — the most efficient way to translate a lot of content.
create_localewriteCreate locale. Add a new locale (language) to the site.
delete_localedestructiveDelete locale. Delete a locale.
delete_translationdestructiveDelete translation. Delete a translation.
list_localesreadList locales. List all locales (languages) configured for the site.
list_translatable_contentreadList translatable content. Discover exactly what can be translated for a page, component, or CMS collection — and the precise source_type/source_id/content_key/content_type to use with set_translation.
list_translationsreadList translations. List existing translations for a specific locale.
set_default_localewriteSet default locale. Set a locale as the default (primary) language for the site.
set_rich_text_translationwriteSet rich text translation. Translate a rich-text content key by passing structured blocks.
set_translationwriteSet translation. Create or update a translation for a specific content key in a locale.
update_localewriteUpdate locale. Update a locale label or set it as default.
update_translationwriteUpdate translation. Update an existing translation value or completion status.

Site settings ​

Site-wide settings such as name, SEO and custom code.

ToolAccessDescription
get_settingsreadGet site settings. Get all site settings or a specific setting by key.
set_settingwriteSet site setting. Set a site setting value.
set_settings_batchwriteSet site settings in batch. Set multiple site settings at once.

Publishing ​

Review drafts and publish them live. See Publishing.

ToolAccessDescription
get_unpublished_changesreadGet unpublished changes. Check what changes are pending and need to be published.
publishdestructivePublish site. Publish all draft changes to make them live.

Cashfin Business API Documentation