ecomone developers
Open Ecomone
Docs / MCP / Tool catalog

MCP tool catalog

91 tools in 18 groups. tools/list only returns the tools your connection's scopes allow; the full input schema of each tool comes from tools/list.

Discovery, rules & setup#

ToolWhat it doesScopeEffect
get_capabilitiesLists, per area, whether this connection can read/edit the shop; with several shops and no shop given, lists the shops (slug, plan status).shop:readread
list_shopsLists the shops this connection covers; use the slug as the shop argument.shop:readread
get_shop_readinessChecks whether the shop is ready to launch (start checklist).shop:readread
list_ai_changesLists the most recent write actions made through the MCP connector, newest first; filterable by period and tool.shop:readread
einrichtenShop setup plan: propose a stored plan, execute it exactly after one merchant confirmation, or read progress. Plan valid 24 h; never publishes.settings:writelive
get_recipeReturns the detailed rulebook for an area (build, popups, email, campaign, growth, service, setup); meant to be called before the first write in that area.shop:readread
checkChecks an area and reports findings: campaign, design, product, email_flow, shipping, tracking, domain.shop:readread

Storefront building (theme, pages, sections, publishing)#

ToolWhat it doesScopeEffect
list_pagesLists the shop's pages and the sections (with ids) on each page.shop:readread
inspect_sectionShows all settings of a section as exact paths with current values.shop:readread
get_section_schemaReturns the available setting paths, block lists and block types of a section type.shop:readread
create_pageCreates a new page (e.g. About, FAQ), optionally with section types. Draft.pages:writedraft / write
set_section_visibilityHides or shows a section (like the eye icon in the editor). Draft.sections:writedraft / write
set_shop_logoSets the shop logo (draft for the storefront; checkout and order pages use it immediately).theme:writedraft / write
list_draftsLists named theme drafts with name and modification date and which one is open.shop:readread
publish_shopPublishes the current draft to all visitors. Live immediately.shop:publishlive
set_storefront_passwordEnables or disables password protection of the live shop. Live immediately.shop:publishlive
acknowledge_commerce_hintAcknowledges a pre-publish commerce check hint so it no longer blocks/appears before publishing.shop:publishlive
list_layout_sectionsLists header, announcement bar, footer and cart drawer with section id, type and short content.shop:readread
set_announcement_barCreates or removes the announcement bar above the header. Draft.sections:writedraft / write
look_atTakes a screenshot of a page or of the signed pop-up preview.shop:readdraft / write
manage_draftCreates, switches to, renames or deletes theme drafts.theme:writedraft / write
manage_sectionAdds, deletes, reorders sections and edits their settings, content and blocks. Draft.sections:writedraft / write
manage_themeReads the theme draft (aktion: get; global custom CSS and head HTML stay hidden) or changes theme typography, colors/palette, fonts, buttons/spacing, favicon, navigation, social links and language selector. Draft.theme:writedraft / write

Media library#

ToolWhat it doesScopeEffect
list_mediaLists images in the merchant's media library (URL, name, width, height, folder).shop:readread
import_media_from_urlImports an image (PNG/JPEG/WebP/GIF/AVIF, max 10 MB) or video (MP4/MOV/WebM, max 200 MB, 3 min) from an https URL into the media library.sections:writedraft / write
generate_media_imageGenerates an AI image into the media library. Costs 1 credit; only with explicit merchant consent.sections:writedraft / write

Products, bundles & collections#

ToolWhat it doesScopeEffect
generate_product_imagesGenerates product images with AI Studio. Costs 1 credit per image; only with explicit merchant consent.products:writelive
get_image_runReads (and advances) the status of a generate_product_images run.products:writelive
list_bundlesLists quantity offers/bundles (tiered prices), optionally for one product.shop:readread
set_product_shippingSets per-product shipping; requires bestaetigt_vom_haendler=true, otherwise returns a summary to confirm. Live at checkout.products:writelive
archive_productArchives a product (or restores it) instead of deleting it. Live immediately.products:writelive
bulk_update_productsUpdates up to 100 products in one call (SKU, barcode, category, vendor, tags, handle, active, costs, weight, origin...). Live immediately.products:writelive
productsLists products; with id/handle returns one product's details.products:readread
collectionsLists collections; with id returns one collection.collections:readread
manage_productCreates or updates products, private digital files and add-on rules. Live immediately.products:writelive
manage_collectionCreates or updates a collection. Live immediately.collections:writelive
manage_bundleCreates or updates a quantity offer/bundle. Live immediately.products:writelive

Inventory#

ToolWhat it doesScopeEffect
get_inventoryStock per product/variant; max 50 per call (default 20), paginated with cursor.inventory:readread
set_inventorySets stock of a product or of individual variants; optionally toggles inventory tracking.inventory:writedraft / write

Orders & invoices#

ToolWhat it doesScopeEffect
get_order_journeyShows where an order came from (source, pages visited before purchase).orders:readread
fulfill_orderSets fulfillment status and tracking data of an order; can send the shipping confirmation.orders:fulfillmentdraft / write
set_order_noteAppends an internal note (never shown to the customer; marked [KI]).orders:notesdraft / write
cancel_orderCancels an order like the order page does; paid orders are refunded via Stripe (full by default, partial via erstattung_cents).orders:cancellive
refund_orderRefunds an amount or individual line items via Stripe; never more than was paid.orders:refundlive
get_invoiceInvoices and credit notes of an order with number, amount, approval state and a link to the PDF.orders:readread
create_invoiceIssues the invoice of an order (assigns the number); unapproved invoices stay drafts. Sends nothing.orders:editdraft / write
export_accountingExports the invoices and credit notes issued in a date range (from/to, YYYY-MM-DD) as accounting CSV, like GET /invoices/accounting. Needs billing permission; changes no documents.orders:readread
resend_order_emailRe-sends the order or shipping confirmation to the customer; requires bestaetigt_vom_haendler=true.orders:fulfillmentdraft / write
ordersLists orders; with id returns one order.orders:readread

Customers#

ToolWhat it doesScopeEffect
customersLists customers; with id returns one customer.customers:readread

Discounts#

ToolWhat it doesScopeEffect
discountsLists discount codes; with id returns one code.discounts:readread
manage_discountCreates or updates a discount code. Live immediately.discounts:writelive

Reviews#

ToolWhat it doesScopeEffect
list_reviewsLists reviews, filterable by status, product and stars.reviews:readread
manage_reviewApproves/hides, replies to or imports reviews, or changes review settings. Live immediately.reviews:writelive

Analytics#

ToolWhat it doesScopeEffect
get_revenueRevenue totals and time series per day/week/month (default last 30 days), in minor units.revenue:readread
get_ads_performancePer campaign/ad set/ad: spend (if Meta is connected), visitors, funnel, orders, revenue, contribution margin, ROAS, POAS, BEROAS, CPA, margin, plus Meta-reported purchases.reports:readread

Pop-ups#

ToolWhat it doesScopeEffect
set_popup_statusSets a pop-up to active, paused or draft. Activating is live immediately.popups:writelive
get_popup_statsImpressions, interactions, wins, contacts, orders, revenue and rates for a period (default 30 days).popups:readread
list_popup_leadsContacts collected by pop-ups (newest first): e-mail, date, pop-up, code, redeemed, consent; max 50 per call.popups:readread
popupsLists pop-ups; with id returns one pop-up.popups:readread
manage_popupCreates or updates a pop-up (always as draft; go live via set_popup_status).popups:writelive

E-mail marketing (flows, designs, segments, campaigns)#

ToolWhat it doesScopeEffect
marketingSegments (create/update/delete/count) and campaigns/series (create, schedule, pause, cancel, delete unsent), test send and statistics. Required scope depends on the action.marketing:readdraft / write
email_flowsLists e-mail flows; with id returns one flow.marketing:readread
email_designsLists e-mail designs; with id returns one design.marketing:readread
preview_emailRenders a preview of a flow e-mail or an order e-mail.marketing:readdraft / write
send_test_emailSends a test e-mail, only to the person who created the key/connection, never to customers.marketing:senddraft / write
manage_email_flowCreates, updates, activates or pauses an e-mail flow.marketing:writedraft / write
manage_email_designCreates or updates an e-mail design.marketing:writedraft / write

Order e-mails & sender domain#

ToolWhat it doesScopeEffect
setup_sender_domainCreates the sender domain for shop e-mails and returns the DNS records (SPF, DKIM, Return-Path).email:writelive
verify_sender_domainVerifies the sender domain and shows the state of each DNS record.email:readread
set_sender_addressesSets sender addresses per purpose (orders, contact, internal) on the verified sender domain.email:writelive
update_order_email_templateChanges subject, HTML body, button or active flag of an order e-mail. Live immediately.email:writelive
order_email_templatesLists order e-mail templates; with id (template key) returns one.email:readread

Inbox / customer service#

ToolWhat it doesScopeEffect
get_support_modeMerchant's inbox mode, approved categories, remaining daily quota and pause state.inbox:readread
list_snippetsInbox text snippets (title, shortcut, text).inbox:readread
conversationsLists inbox conversations; with id returns one conversation.inbox:readread
manage_conversationInbox actions: drafts (own text, snippet, AI suggestion, forward), categorise, snooze, labels, spam, send a saved draft (only with merchant approval).inbox:writelive

Settings, legal texts & languages#

ToolWhat it doesScopeEffect
get_legal_pagesLists imprint, terms, privacy, withdrawal, shipping terms and contact text with fill status.settings:readread
generate_legal_pagesFills legal text templates from shop, company and market data; overwrites only with ueberschreiben=true.settings:writelive
languagesChanges enabled/default storefront languages (with confirmation) and manages the translation glossary.settings:writelive
translationsReads and sets translations, lists gaps, estimates and starts/cancels/resumes translation jobs.settings:writelive
get_settingsReads settings of one area: shop, company, tracking, email (sender), reviews, shipping.shop:readread
update_settingsChanges shop data, company data or a legal text. Live immediately.settings:writelive

Markets, taxes & shipping#

ToolWhat it doesScopeEffect
set_shippingSets up shipping rates; requires bestaetigt_vom_haendler=true, otherwise returns a summary to confirm. Live at checkout.shop:writelive
list_marketsLists markets with countries, currency, tax settings, rates per country, primary market, status and shipping rates.markets:readread
manage_marketCreates or updates a market; sales-relevant changes require merchant confirmation.markets:writelive

Tracking#

ToolWhat it doesScopeEffect
update_tracking_settingsChanges tracking settings (pixels, tracking tier, consent). Live immediately.tracking:writelive

Domains#

ToolWhat it doesScopeEffect
get_domainsConnected domains with status, primary domain and required DNS records.domains:readread
add_domainConnects a domain the merchant already owns.domains:writelive
buy_domainDoes not buy anything: returns the backend link where the merchant can buy or transfer a domain.domains:readread
manage_domainSets the primary domain or removes a domain. Live immediately.domains:writelive

Authorize requests

Requests go straight from your browser to https://api.ecomone.shop. Your credentials stay in this browser tab and are never sent to this documentation site.