Skip to content

MCP Server recipes

Worked patterns for getting useful results out of an MCP-connected assistant. Each one shows what to ask, which tools it exercises, and what to watch for.

All read recipes work under the Read-only profile. The enrichment recipes at the end need Full access.

Get oriented in a new catalog

Before asking anything specific, establish what exists.

What tables are in my catalog, and how many records does each one have?

This runs list_custom_entities followed by get_entity_counts, and gives you standard tables plus any custom entities with their record counts.

Then narrow to the table you care about:

Give me a complete picture of the Products table — how many records, which fields, and which are multilingual.

This runs get_table_info, which returns counts, fields with human-readable titles, types, multilingual flags, and pagination limits in one call.

Ask for languages explicitly if you will be working with translations:

Which languages are configured in this catalog, and which fields are multilingual?

That runs get_catalog_locales.

Search a multilingual catalog

This is the most common source of empty results. A plain text search covers the default language only, so a Spanish term will not match content stored in English.

Instead of relying on a bare search, name the language:

Find products with "Abrigo" in the Spanish title.

This runs get_products with a filter such as contains(prod_title_es, 'Abrigo').

When you are unsure which language holds the data, ask for both:

Find products with "Coat" in English or "Abrigo" in Spanish.

If a search comes back empty and you suspect a language mismatch:

How should I search this catalog across multiple languages?

That runs help_search_multilingual, which reports the configured languages and shows patterns using your real field names.

Keep in mind that an empty value for a language means the field is not translated. It does not fall back to the base language.

Audit data quality

Counting before listing keeps responses manageable.

How many products are visible, and how many are drafts?

This runs get_total_count twice with filters on prod_stat, without downloading records.

Then find the gaps:

List visible products that have no English description. Show reference and title.

Which categories have no products assigned?

Show me products whose title exists in English but not in Spanish.

For the last one, ask the assistant to select both language fields explicitly, so untranslated values are visible as empty rather than absent.

Explore structure before building a REST integration

The MCP Server is a fast way to understand a catalog you are about to integrate with over the Catalog REST API.

What fields does the Products table have, with their types and which ones are images or files?

This runs get_entity_fields with field_type filtering.

I want to fetch all visible products with their images, as efficiently as possible. What query should I use?

This runs suggest_optimal_query, which proposes filters, field selection, and performance settings. Treat the result as a starting point and verify it against Filter and Select before putting it in production code.

Work through large result sets

Ask for the shape of the data before the data itself.

How many products match status visible and category SUMMER2024?

Then request a first page, and continue:

Show me the first page of those products.

Get the next page.

The second request runs get_next_page using the @nextLink from the previous response, which preserves the original filters. Page size limits vary by entity — ask the assistant to check get_pagination_info rather than assuming a number.

For large exports, the REST API is the better tool. See Pagination strategies.

Two shortcuts avoid hand-built filters.

Show me all products in the Summer 2024 category.

The assistant resolves the category reference to its numeric ID, then calls get_category_products.

What variants does product 42PH220506712 have?

Same pattern with get_product_variants.

Both relationship tools require the numeric internal ID. The assistant can resolve it from the business reference with get_categories or get_products first.

Review changes with changelogs

Use resource changelogs when you need to understand what changed without downloading every current record.

Show Product changes since yesterday, newest first.

This runs get_products_changelog with a date filter and descending order. For one known Product, ask for its numeric ID first and then use get_product_changelog. Equivalent tools exist for Categories, Variants, and Custom Entities.

Inspect Attribute Sets and layouts

List the Attribute Sets in this catalog, then show me the Product and Variant layout for the set used by product COAT001.

This combines get_attribute_sets, get_products, and get_attribute_set. Attribute Set and layout writes replace complete structures, so always fetch the current value before proposing a change.

Enrich content

These need Full access. Read the current record first and keep your MCP client's tool approval enabled.

Start narrow and verify:

Show the current titles for product COAT001. Do not change anything yet.

After reviewing the result, ask:

Update the Spanish title of product COAT001 to "Abrigo de Lana Merino".

The assistant calls update_product. This dedicated update tool executes when called; it does not provide a server-side preview. The separate read and your client's approval prompt are the review steps.

Set product COAT001 to draft status.

For anything touching more than one record, ask for the list first:

List the visible products with no Spanish description.

Then work through them deliberately rather than asking for a blanket update. A bulk instruction gives you one preview for many changes, which is exactly the situation where an error is easiest to approve by accident.

Test enrichment flows against a non-production catalog before running them against live data.

Custom Entity create/update/delete tools do have a two-step preview. Category, Product, and Variant deletes also require a second call with confirm: true.

Work with DAM assets

Find PDF files whose name contains "datasheet" and show whether each one is still linked.

This runs dam_filter_files. Before deleting a file, inspect its numLinks value with dam_get_file; deletion does not repoint Catalog records.

For images, account for asynchronous processing:

Import the image at https://example.com/images/coat-front.jpg, then check when it is ready.

This uses dam_create_image, followed by dam_get_image until the status reaches Ok or Er. DAM writes execute when called and do not implement a server-side confirmation step.

Diagnose a session

When something behaves oddly:

Validate my token and tell me which catalog it points to.

The catalog was updated outside this session and I am seeing stale data.

The second prompt leads to cache_clear, which needs Full access. Under Read-only, start a new session instead.

See Troubleshooting for connection-level problems.