Skip to content

MCP Server tool reference

The Full access profile advertises 71 tools. The Read-only profile advertises the read subset and filters out every write tool. Together they cover Catalog data, schema, layouts and changelogs, plus DAM images and non-image files.

You do not call these tools as HTTP endpoints. Your AI assistant selects and calls them through Model Context Protocol. Tools marked Write are available only under the Full access profile. See Access profiles and permissions.

Catalog tools use the Catalog REST API. DAM tools use the DAM REST API. REST rules for filtering, field selection, pagination, and errors still define the underlying behavior.

Tool catalog

ToolGroupAccess
versionServerRead
validate_tokenMetadata and schemaRead
get_catalog_infoMetadata and schemaRead
get_catalog_localesMetadata and schemaRead
get_metadataMetadata and schemaRead
get_entity_fieldsMetadata and schemaRead
get_table_infoMetadata and schemaRead
get_attribute_setsAttribute SetsRead
get_attribute_setAttribute SetsRead
create_attribute_setAttribute SetsWrite
update_attribute_setAttribute SetsWrite
delete_attribute_setAttribute SetsWrite
get_categoriesCategoriesRead
get_category_productsCategoriesRead
get_category_layoutCategoriesRead
get_category_metadataCategoriesRead
get_categories_changelogCategoriesRead
get_category_changelogCategoriesRead
create_categoryCategoriesWrite
update_categoryCategoriesWrite
delete_categoryCategoriesWrite
update_category_layoutCategoriesWrite
get_productsProductsRead
search_productsProductsRead
get_product_variantsProductsRead
get_product_metadataProductsRead
get_products_changelogProductsRead
get_product_changelogProductsRead
create_productProductsWrite
update_productProductsWrite
delete_productProductsWrite
get_variantsVariantsRead
get_variant_metadataVariantsRead
get_variants_changelogVariantsRead
get_variant_changelogVariantsRead
create_variantVariantsWrite
update_variantVariantsWrite
delete_variantVariantsWrite
list_custom_entitiesCustom EntitiesRead
get_custom_entityCustom EntitiesRead
get_custom_entity_metadataCustom EntitiesRead
get_custom_entity_layoutCustom EntitiesRead
get_custom_entity_changelogCustom EntitiesRead
get_custom_entity_item_changelogCustom EntitiesRead
create_custom_entityCustom EntitiesWrite
update_custom_entityCustom EntitiesWrite
delete_custom_entityCustom EntitiesWrite
update_custom_entity_layoutCustom EntitiesWrite
search_catalogSearch and analysisRead
build_dynamic_querySearch and analysisRead
suggest_optimal_querySearch and analysisRead
analyze_data_structureSearch and analysisRead
get_total_countCounts and paginationRead
get_entity_countsCounts and paginationRead
get_pagination_infoCounts and paginationRead
get_next_pageCounts and paginationRead
help_troubleshootDiagnostics and cacheRead
help_search_multilingualDiagnostics and cacheRead
cache_statsDiagnostics and cacheRead
cache_clearDiagnostics and cacheWrite
cache_controlDiagnostics and cacheWrite
dam_filter_imagesDAM ImagesRead
dam_get_imageDAM ImagesRead
dam_create_imageDAM ImagesWrite
dam_update_imageDAM ImagesWrite
dam_delete_imageDAM ImagesWrite
dam_filter_filesDAM FilesRead
dam_get_fileDAM FilesRead
dam_create_fileDAM FilesWrite
dam_update_fileDAM FilesWrite
dam_delete_fileDAM FilesWrite

Server, metadata, and schema

Use these tools to establish which catalog, languages, entities, and fields are available before you read or write records.

ToolPurposeMain parameters
versionReturns the MCP Server version for diagnostics.None
validate_tokenValidates catalog access and identifies the connected catalog.None
get_catalog_infoSummarizes catalog languages and multilingual fields.None
get_catalog_localesReturns structured locale data and multilingual fields per entity.None
get_metadataReturns the root Catalog service metadata.force_refresh
get_entity_fieldsLists fields, titles, types, multilingual flags, and enum values for an entity.entity; optional field filters
get_table_infoCombines counts, fields, languages, and pagination guidance for one entity.entity; optional filters

Use get_category_metadata, get_product_metadata, get_variant_metadata, or get_custom_entity_metadata when you need metadata for one specific resource. For a custom entity, pass its exact entity_name.

Reading Catalog data

The main collection tools are entity-specific:

ToolReadsMain parameters
get_categoriesCategoriesfilters, select, top, expand, orderby, include, expand_cultures, smart_select, show_all_fields
get_productsProductsfilters, select, top, expand, orderby, include, expand_cultures, smart_select, show_all_fields
get_variantsVariantsfilters, select, top, include, expand_cultures, smart_select, show_all_fields
get_custom_entityItems from one custom entityentity_name, filters, select, top, expand_cultures, smart_select, show_all_fields

Page-size limits vary by entity. Ask the assistant to call get_pagination_info; do not assume a fixed $top value.

Use internal field names in filters and payloads, but use the human-readable field titles returned in metadata when presenting results. Common prefixes are cat_ for Categories, prod_ for Products, and frmt_ for Variants. Custom Entity prefixes differ by catalog.

Relationships

get_category_products reads the products below one category and requires numeric category_id. get_product_variants reads the variants below one product and requires numeric product_id. Resolve a business reference with get_categories or get_products first when necessary.

Changelogs

The following tools support OData filtering, ordering, and pagination over changelog records:

ScopeAll recordsOne record
Categoriesget_categories_changelogget_category_changelog with category_id
Productsget_products_changelogget_product_changelog with product_id
Variantsget_variants_changelogget_variant_changelog with variant_id
Custom Entitiesget_custom_entity_changelog with entity_nameget_custom_entity_item_changelog with entity_name and id

These endpoints do not support field selection or navigation expansion.

Attribute Sets and layouts

Attribute Sets v2 control the Product layout and, optionally, the Variant layout assigned to a set of products.

ToolPurposeMain parameters
get_attribute_setsLists attribute set identifiers and names.None
get_attribute_setGets the complete Product and Variant layout for one set.id, including default
create_attribute_setCreates a set using existing attributes.name; optional productLayout, variantLayout
update_attribute_setRenames a set or replaces either layout.id; optional name, productLayout, variantLayout
delete_attribute_setDeletes a non-default set.id, optional deleteAssociatedProductsAndVariants

A supplied layout is a full structure, not a merge. Attribute IDs must already exist in the catalog. Before setting deleteAssociatedProductsAndVariants: true, note that the products and variants assigned to the set are deleted rather than reassigned to the default set.

Categories have one shared layout. Custom Entity layouts are selected by entity_name.

ToolAccessBehavior
get_category_layoutReadReturns the Category form layout.
update_category_layoutWriteFully replaces the Category form layout.
get_custom_entity_layoutReadReturns the layout for one Custom Entity.
update_custom_entity_layoutWriteFully replaces an existing Custom Entity layout.

Call the corresponding get_*_layout tool first. Layout updates replace the full stored layout; they do not merge individual rows or fields.

Search and analysis

ToolPurposeMain parameters
search_catalogSearches title and reference fields in Categories, Products, or Variants.query; optional entity, filters, top
search_productsSearches Product titles with category, status, price, and Variant options.query; optional structured filters
build_dynamic_queryBuilds and runs an OData query from a goal and key-value filters.entity; optional search_term, filters, include_related, smart_select, max_results
suggest_optimal_queryRecommends a query shape without changing data.entity; optional user_intent, performance_priority
analyze_data_structureSamples records and reports fields, types, values, and total count.entity; optional sample_size, analyze_custom_fields

Plain text search targets the default catalog language. For another language, query its suffixed field explicitly, such as prod_title_es, or use help_search_multilingual.

Counts, pagination, diagnostics, and cache

ToolPurposeMain parameters
get_total_countCounts one standard or custom entity without downloading its records.entity; optional filters, custom_entity_name
get_entity_countsCounts several comma-separated entities in one request.entities
get_pagination_infoReports or probes current pagination limits.optional entity, detect_limits
get_next_pageFollows an @nextLink from a previous response.next_url; optional entity_type
help_troubleshootReturns guidance for a described problem.optional issue
help_search_multilingualReturns language-aware search guidance.optional entity, search_context
cache_statsReports cache use and performance.optional detailed
cache_clearClears cached data after confirmation.optional entity, confirm
cache_controlEnables, disables, or reports cache state.action

cache_clear and cache_control change server runtime state, so they require Full access even though they do not modify Catalog or DAM records.

Writing Catalog data

Use the dedicated tool for the entity you are changing. Discover fields with get_entity_fields or the resource metadata tool first; Catalog schemas and multilingual configuration vary by tenant.

EntityCreateUpdateDelete
Categoriescreate_categoryupdate_categorydelete_category
Productscreate_productupdate_productdelete_product
Variantscreate_variantupdate_variantdelete_variant
Custom Entitiescreate_custom_entityupdate_custom_entitydelete_custom_entity

Category, Product, and Variant create/update tools execute when called. Their delete tools require a second call with confirm: true. Deleting a Product also deletes its Variants.

Custom Entity create, update, and delete tools use a two-step preview and confirmation flow. Pass entity_name and use the entity's real metadata to build data. Updates and deletes accept either numeric id or business ref, but not both. Custom Entity deletion does not check relationships.

Full access is not a substitute for review: some write tools do not have a server-side preview. Use a client that asks before tool execution and test write workflows against a non-production catalog.

DAM Images

DAM Images are separate from Catalog records and from the DAM Files library.

ToolAccessPurposeMain parameters
dam_filter_imagesReadLists and filters images with pagination.optional filter, orderby, top, skip
dam_get_imageReadGets one image and its processing status.reference
dam_create_imageWriteImports an image from a public HTTP or HTTPS URL.url; optional tags
dam_update_imageWriteReplaces image content and/or tags without changing its reference.reference; url and/or tags
dam_delete_imageWritePermanently deletes an image.reference

Image import and content replacement are asynchronous. Use dam_get_image until the status is Ok or Er. A replacement URL may use a different filename, but the image keeps its existing reference and the replacement's actual file type must match. Omitting tags leaves them unchanged; send an empty array to clear them.

DAM Files

DAM Files cover non-image assets such as documents, spreadsheets, archives, presentations, video, and design files.

ToolAccessPurposeMain parameters
dam_filter_filesReadLists and filters files with pagination.optional filter, orderby, top, skip
dam_get_fileReadGets one file, including its numLinks value.reference
dam_create_fileWriteImports a file from a public HTTP or HTTPS URL.url; optional tags
dam_update_fileWriteReplaces file content and/or tags without changing its reference.reference; url and/or tags
dam_delete_fileWritePermanently deletes a file.reference

Files are available immediately; they do not use the background image-processing flow. Before deleting a file, inspect numLinks: the delete tool does not repoint Catalog records that still reference it.

Backward compatibility

Older clients may still know the generic tools get_table_items, create_item, update_item, and delete_item. They remain routable for compatibility but are hidden from tool discovery. New connections should use the dedicated entity tools documented on this page.