{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"seo":{"title":"MCP Server tool reference","description":"Reference for Sales Layer MCP tools that let AI assistants work with PIM catalog data, layouts, changelogs, images, and files.","siteUrl":"https://docs.api.saleslayer.com/","image":"/assets/sales-layer-horizontal-dark-green.224c048d0bb386d3c2683ba504140512b6233d3c6cbf706ca81e2e3f2f02dbd0.9c1bb791.svg","keywords":["Sales Layer","Sales Layer API","REST API","OpenAPI","PIM API","Product Information Management API","DAM API","Catalog API","product catalog API","product data synchronization","ecommerce integration API","ERP integration","marketplace integration","image management API","digital asset management API","API integration","Model Context Protocol","MCP server","Sales Layer MCP","AI assistant connector","PIM AI assistant"],"lang":"en-US","meta":[{"name":"og:type","content":"website"},{"name":"og:site_name","content":"Sales Layer REST API Documentation"},{"name":"og:title","content":"Sales Layer REST API Documentation"},{"name":"og:description","content":"Technical REST API docs for Sales Layer PIM, Catalog, DAM, ecommerce, ERP, and marketplace integrations."},{"name":"og:image","content":"/assets/sales-layer-horizontal-dark-green.224c048d0bb386d3c2683ba504140512b6233d3c6cbf706ca81e2e3f2f02dbd0.9c1bb791.svg"},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:site","content":"@saleslayer"},{"name":"twitter:title","content":"Sales Layer REST API Documentation"},{"name":"twitter:description","content":"Technical REST API docs for Sales Layer PIM, Catalog, DAM, ecommerce, ERP, and marketplace integrations."},{"name":"twitter:image","content":"/assets/sales-layer-horizontal-dark-green.224c048d0bb386d3c2683ba504140512b6233d3c6cbf706ca81e2e3f2f02dbd0.9c1bb791.svg"}],"llmstxt":{"hide":false,"title":"Sales Layer REST API Documentation","description":"Technical guides and OpenAPI references for Sales Layer DAM and Catalog REST APIs.","sections":[{"title":"Guides","description":"Static API guides for authentication, headers, query parameters, responses, rate limiting, and best practices.","includeFiles":["guides/**/*.md","changelog.md"]},{"title":"API Reference","description":"OpenAPI-based references and API overview pages for Sales Layer REST APIs.","includeFiles":["apis/**/*.md","apis/**/*.yaml"]},{"title":"Postman collections","description":"Importable Postman collection and environment instructions for testing Sales Layer REST APIs.","includeFiles":["postman/**/*.md"]},{"title":"MCP server","description":"Documentation for the Sales Layer MCP Server, its tools, access profiles, and how AI assistants consume the Catalog REST API.","includeFiles":["mcp-server/**/*.md"]}]},"jsonLd":{"@context":"https://schema.org","@type":"WebSite","name":"Sales Layer REST API Documentation","url":"https://docs.api.saleslayer.com/","publisher":{"@type":"Organization","name":"Sales Layer","url":"https://www.saleslayer.com/"}}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"mcp-server-tool-reference","__idx":0},"children":["MCP Server tool reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You do not call these tools as HTTP endpoints. Your AI assistant selects and calls them through"," ","Model Context Protocol. Tools marked ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}," are available only under the Full access profile."," ","See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/mcp-server/permissions"},"children":["Access profiles and permissions"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Catalog tools use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/catalog"},"children":["Catalog REST API"]},". DAM tools use the"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/dam"},"children":["DAM REST API"]},". REST rules for ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/filter"},"children":["filtering"]},","," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/select"},"children":["field selection"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/pagination-and-filtering"},"children":["pagination"]},", and"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/errors"},"children":["errors"]}," still define the underlying behavior."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tool-catalog","__idx":1},"children":["Tool catalog"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Group"},"children":["Group"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Access"},"children":["Access"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validate_token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata and schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_catalog_info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata and schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_catalog_locales"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata and schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata and schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_entity_fields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata and schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_table_info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata and schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_attribute_sets"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attribute Sets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attribute Sets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attribute Sets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attribute Sets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attribute Sets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_categories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_categories_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_category_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_product_variants"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_product_metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_products_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_product_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_product"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_product"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_product"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variants"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variant_metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variants_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variant_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_variant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_variant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_variant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list_custom_entities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_item_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_custom_entity_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_catalog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search and analysis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["build_dynamic_query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search and analysis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggest_optimal_query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search and analysis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["analyze_data_structure"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search and analysis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_total_count"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Counts and pagination"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_entity_counts"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Counts and pagination"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_pagination_info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Counts and pagination"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_next_page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Counts and pagination"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["help_troubleshoot"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Diagnostics and cache"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["help_search_multilingual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Diagnostics and cache"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_stats"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Diagnostics and cache"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_clear"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Diagnostics and cache"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_control"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Diagnostics and cache"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_filter_images"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Images"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_get_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Images"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_create_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Images"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_update_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Images"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_delete_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Images"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_filter_files"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_get_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_create_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_update_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_delete_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM Files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"server-metadata-and-schema","__idx":2},"children":["Server, metadata, and schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these tools to establish which catalog, languages, entities, and fields are available before"," ","you read or write records."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the MCP Server version for diagnostics."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validate_token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validates catalog access and identifies the connected catalog."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_catalog_info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Summarizes catalog languages and multilingual fields."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_catalog_locales"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns structured locale data and multilingual fields per entity."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the root Catalog service metadata."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["force_refresh"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_entity_fields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists fields, titles, types, multilingual flags, and enum values for an entity."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},"; optional field filters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_table_info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Combines counts, fields, languages, and pagination guidance for one entity."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_metadata"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_product_metadata"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variant_metadata"]},", or"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_metadata"]}," when you need metadata for one specific resource. For a custom"," ","entity, pass its exact ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_name"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reading-catalog-data","__idx":3},"children":["Reading Catalog data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The main collection tools are entity-specific:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Reads"},"children":["Reads"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_categories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand_cultures"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smart_select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["show_all_fields"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand_cultures"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smart_select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["show_all_fields"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variants"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand_cultures"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smart_select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["show_all_fields"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Items from one custom entity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand_cultures"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smart_select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["show_all_fields"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Page-size limits vary by entity. Ask the assistant to call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_pagination_info"]},"; do not assume a"," ","fixed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$top"]}," value."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use internal field names in filters and payloads, but use the human-readable field titles returned"," ","in metadata when presenting results. Common prefixes are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cat_"]}," for Categories, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod_"]}," for"," ","Products, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["frmt_"]}," for Variants. Custom Entity prefixes differ by catalog."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"relationships","__idx":4},"children":["Relationships"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_products"]}," reads the products below one category and requires numeric ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category_id"]},"."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_product_variants"]}," reads the variants below one product and requires numeric ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["product_id"]},"."," ","Resolve a business reference with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_categories"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_products"]}," first when necessary."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"changelogs","__idx":5},"children":["Changelogs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following tools support OData filtering, ordering, and pagination over changelog records:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"All records"},"children":["All records"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"One record"},"children":["One record"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_categories_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_changelog"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category_id"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_products_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_product_changelog"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["product_id"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variants_changelog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_variant_changelog"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["variant_id"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_changelog"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_item_changelog"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_name"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints do not support field selection or navigation expansion."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"attribute-sets-and-layouts","__idx":6},"children":["Attribute Sets and layouts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Attribute Sets v2 control the Product layout and, optionally, the Variant layout assigned to a"," ","set of products."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_attribute_sets"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists attribute set identifiers and names."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gets the complete Product and Variant layout for one set."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["default"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creates a set using existing attributes."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["productLayout"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["variantLayout"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Renames a set or replaces either layout."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["productLayout"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["variantLayout"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_attribute_set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deletes a non-default set."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteAssociatedProductsAndVariants"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A supplied layout is a full structure, not a merge. Attribute IDs must already exist in the"," ","catalog. Before setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteAssociatedProductsAndVariants: true"]},", note that the products and"," ","variants assigned to the set are deleted rather than reassigned to the default set."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Categories have one shared layout. Custom Entity layouts are selected by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_name"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Access"},"children":["Access"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_category_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the Category form layout."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_category_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fully replaces the Category form layout."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_custom_entity_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the layout for one Custom Entity."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_custom_entity_layout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fully replaces an existing Custom Entity layout."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call the corresponding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_*_layout"]}," tool first. Layout updates replace the full stored layout;"," ","they do not merge individual rows or fields."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-and-analysis","__idx":7},"children":["Search and analysis"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_catalog"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Searches title and reference fields in Categories, Products, or Variants."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Searches Product titles with category, status, price, and Variant options."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]},"; optional structured filters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["build_dynamic_query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Builds and runs an OData query from a goal and key-value filters."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_term"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include_related"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smart_select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["max_results"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggest_optimal_query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommends a query shape without changing data."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_intent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["performance_priority"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["analyze_data_structure"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Samples records and reports fields, types, values, and total count."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sample_size"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["analyze_custom_fields"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Plain text search targets the default catalog language. For another language, query its suffixed"," ","field explicitly, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod_title_es"]},", or use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["help_search_multilingual"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"counts-pagination-diagnostics-and-cache","__idx":8},"children":["Counts, pagination, diagnostics, and cache"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_total_count"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Counts one standard or custom entity without downloading its records."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_entity_name"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_entity_counts"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Counts several comma-separated entities in one request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entities"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_pagination_info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reports or probes current pagination limits."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detect_limits"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_next_page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Follows an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@nextLink"]}," from a previous response."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next_url"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["help_troubleshoot"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns guidance for a described problem."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issue"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["help_search_multilingual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns language-aware search guidance."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_context"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_stats"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reports cache use and performance."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detailed"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_clear"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clears cached data after confirmation."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirm"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_control"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enables, disables, or reports cache state."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["action"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_clear"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cache_control"]}," change server runtime state, so they require Full access even"," ","though they do not modify Catalog or DAM records."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"writing-catalog-data","__idx":9},"children":["Writing Catalog data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the dedicated tool for the entity you are changing. Discover fields with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_entity_fields"]}," ","or the resource metadata tool first; Catalog schemas and multilingual configuration vary by"," ","tenant."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Entity"},"children":["Entity"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Create"},"children":["Create"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Update"},"children":["Update"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Delete"},"children":["Delete"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Categories"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_category"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_product"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_product"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_product"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_variant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_variant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_variant"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_custom_entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete_custom_entity"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Category, Product, and Variant create/update tools execute when called. Their delete tools require"," ","a second call with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirm: true"]},". Deleting a Product also deletes its Variants."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom Entity create, update, and delete tools use a two-step preview and confirmation flow. Pass"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_name"]}," and use the entity's real metadata to build ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},". Updates and deletes accept either"," ","numeric ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," or business ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref"]},", but not both. Custom Entity deletion does not check relationships."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"dam-images","__idx":10},"children":["DAM Images"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DAM Images are separate from Catalog records and from the DAM Files library."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Access"},"children":["Access"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_filter_images"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists and filters images with pagination."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skip"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_get_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gets one image and its processing status."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_create_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Imports an image from a public HTTP or HTTPS URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_update_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Replaces image content and/or tags without changing its reference."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," and/or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_delete_image"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permanently deletes an image."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Image import and content replacement are asynchronous. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_get_image"]}," until the status is"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ok"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Er"]},". A replacement URL may use a different filename, but the image keeps its existing"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}," and the replacement's actual file type must match. Omitting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}," leaves them"," ","unchanged; send an empty array to clear them."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"dam-files","__idx":11},"children":["DAM Files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DAM Files cover non-image assets such as documents, spreadsheets, archives, presentations, video,"," ","and design files."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Access"},"children":["Access"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Main parameters"},"children":["Main parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_filter_files"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists and filters files with pagination."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skip"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_get_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gets one file, including its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numLinks"]}," value."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_create_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Imports a file from a public HTTP or HTTPS URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]},"; optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_update_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Replaces file content and/or tags without changing its reference."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," and/or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dam_delete_file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permanently deletes a file."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Files are available immediately; they do not use the background image-processing flow. Before"," ","deleting a file, inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numLinks"]},": the delete tool does not repoint Catalog records that still"," ","reference it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"backward-compatibility","__idx":12},"children":["Backward compatibility"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Older clients may still know the generic tools ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_table_items"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_item"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["update_item"]},", and"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-pages","__idx":13},"children":["Related pages"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/mcp-server/permissions"},"children":["Access profiles and permissions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/mcp-server/recipes"},"children":["Recipes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/mcp-server/troubleshooting"},"children":["Troubleshooting"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/catalog"},"children":["Catalog REST API overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/dam"},"children":["DAM REST API overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/pagination-and-filtering"},"children":["Pagination and filtering"]}]}]}]},"headings":[{"value":"MCP Server tool reference","id":"mcp-server-tool-reference","depth":1},{"value":"Tool catalog","id":"tool-catalog","depth":2},{"value":"Server, metadata, and schema","id":"server-metadata-and-schema","depth":2},{"value":"Reading Catalog data","id":"reading-catalog-data","depth":2},{"value":"Relationships","id":"relationships","depth":3},{"value":"Changelogs","id":"changelogs","depth":3},{"value":"Attribute Sets and layouts","id":"attribute-sets-and-layouts","depth":2},{"value":"Search and analysis","id":"search-and-analysis","depth":2},{"value":"Counts, pagination, diagnostics, and cache","id":"counts-pagination-diagnostics-and-cache","depth":2},{"value":"Writing Catalog data","id":"writing-catalog-data","depth":2},{"value":"DAM Images","id":"dam-images","depth":2},{"value":"DAM Files","id":"dam-files","depth":2},{"value":"Backward compatibility","id":"backward-compatibility","depth":2},{"value":"Related pages","id":"related-pages","depth":2}],"frontmatter":{"seo":{"title":"MCP Server tool reference","description":"Reference for Sales Layer MCP tools that let AI assistants work with PIM catalog data, layouts, changelogs, images, and files."},"keywords":{"includes":["MCP tools","MCP tool reference","Sales Layer MCP","AI assistant catalog tools","DAM MCP tools","Model Context Protocol"]},"metadata":{"redocly_category":"MCP Server","api_domain":"MCP"}},"lastModified":"2026-08-31T15:07:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/mcp-server/tools","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}