{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-ai/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown","redocly_category":"Development","owner":"MB"},"seo":{"title":"AI - Norce Config MCP Tool Reference","description":"Reference for all tools exposed by the Norce Config MCP Server — applications, stores, sales areas, VAT codes, and configuration validation.","keywords":"MCP, model context protocol, config MCP, applications, stores, sales areas, VAT codes, tool reference"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"norce-config-mcp--tool-reference"},"children":["Norce Config MCP — Tool Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page documents the tools exposed by the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Norce Config MCP Server"]},". For setup and connection instructions, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/ai/using-the-norce-backend-mcp-servers"},"children":["Using the Norce Backend MCP Servers"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Config MCP is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["read-only"]}," server in this version. Write tools for creating and updating configuration are planned for a future release."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response_format"]}," parameter:"]}," Most tools accept a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response_format"]}," parameter — either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"markdown\""]}," (default, human-readable) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"json\""]}," (for programmatic use). This parameter is not listed individually under each tool."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"a-note-on-application-ids"},"children":["A note on application IDs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Config MCP tools require an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["application ID"]}," as input. In this version there is no tool to discover application IDs without one — the initial application ID must be known in advance and provided to the AI through your system prompt or explicitly at the start of a conversation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find your application ID in Norce Admin, or ask your Norce contact. Once you have one, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_list_applications"]}," can retrieve the full list."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tools"},"children":["Tools"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-applications"},"children":["List Applications"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_list_applications"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists all applications (storefronts) configured for the client, with their IDs, names, URLs, and active status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use this tool"]}," as the starting point when you need to know which applications exist — for example before calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_application_overview"]},", or to look up an application ID to use in other MCP servers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applicationId"]}," — any valid application ID for the client. Used to identify the account; the tool returns all applications for that client."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A list of applications with their IDs, names, URLs, and active status."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-client-overview"},"children":["Get Client Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_client_overview"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a consolidated snapshot of the client's top-level configuration: all applications, client-level sales areas (including VAT codes), and currencies with exchange rates."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use this tool"]}," as the first step in most support and validation workflows. It gives a broad picture of how the client is set up without needing to drill into individual applications or stores. It is also the right starting point when you need sales area IDs or VAT code IDs to use in the Pricing MCP."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applicationId"]}," — any valid application ID for the client."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applications"]}," — all storefronts with status and URLs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["salesAreas"]}," — client-level sales areas, each with their VAT codes and IDs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencies"]}," — active currencies with exchange rates."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-application-overview"},"children":["Get Application Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_application_overview"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a consolidated configuration snapshot for a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["specific application"]},": its details, the cultures, sales areas, and currencies active at the application level."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use this tool"]}," when you need to know what a particular storefront exposes to end customers — which languages, markets, and currencies are active for that application specifically, as opposed to the broader client-level configuration."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applicationId"]}," — the ID of the application to inspect."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application"]}," — name, URL, and active status."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cultures"]}," — languages active for this application, with primary flag."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["salesAreas"]}," — sales areas active at the application level."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currencies"]}," — currencies available to this storefront."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-stores"},"children":["List Stores"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_list_stores"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists all stores (physical or logical divisions) configured for the client, with their IDs, division codes, names, group classification, and active status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use this tool"]}," when you need to find a store ID before calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_store_overview"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_check_store_setup"]},". Store IDs and division codes returned here are also used as cross-references in the Inventory MCP and Pricing MCP."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applicationId"]}," — any valid application ID for the client."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A list of stores with their IDs, division codes, names, group classification, and active status."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-store-overview"},"children":["Get Store Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_store_overview"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a full configuration snapshot for a specific store: its details, linked warehouses, linked price lists, linked applications, and culture-specific names."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use this tool"]}," when you need cross-reference data for other MCP servers — for example, to find which warehouse IDs are linked to a store (for the Inventory MCP) or which price list IDs are assigned to it (for the Pricing MCP). Also use it as a pre-read before any store association changes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applicationId"]}," — any valid application ID for the client."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["storeId"]}," — the store ID from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_list_stores"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouses"]}," — linked warehouses with IDs and location references."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["priceLists"]}," — linked price lists with IDs and codes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applications"]}," — storefronts this store is visible in."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store details including address, contact, open hours, and location coordinates."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"check-store-setup"},"children":["Check Store Setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_check_store_setup"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validates the configuration of a specific store and returns a structured diagnostic report with issues, warnings, and passed checks."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use this tool"]}," during pre-deployment validation or when diagnosing a store that is behaving unexpectedly. It is more efficient than manually inspecting each setting — the tool checks all critical configuration points in one call and surfaces exactly what is missing or misconfigured."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Checks performed"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store is active."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store has a division code (required for integration and availability lookups)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["At least one warehouse is linked."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each warehouse link has a location ID set (required for accurate inventory lookups)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["At least one price list is linked."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["At least one application is linked (required for storefront visibility)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applicationId"]}," — any valid application ID for the client."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["storeId"]}," — the store ID from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_list_stores"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A diagnostic report with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issues[]"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warnings[]"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["passed[]"]},", and an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allOk"]}," boolean."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-workflows"},"children":["Typical workflows"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"starting-a-support-investigation"},"children":["Starting a support investigation"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_client_overview"]}," to get a broad picture of the client's setup — applications, sales areas, and currencies in one call."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the issue is related to a specific storefront, follow up with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_application_overview"]}," for that application."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the issue involves stock or pricing, use the warehouse IDs and price list IDs from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_store_overview"]}," as input to the Inventory MCP and Pricing MCP."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"validating-a-store-before-go-live"},"children":["Validating a store before go-live"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_list_stores"]}," to find the store ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_check_store_setup"]}," with that store ID to run the full validation check."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If any issues are reported, call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_store_overview"]}," to inspect the current state and identify what needs to be corrected."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/config-mcp-check-store-setup.e159a8467ff340c53c32089540cff2774f0ebe4d724817cbd9b2f4181310ad17.fe4eaf73.png","alt":"Example response from norce_config_check_store_setup"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fetching-reference-data-for-other-mcp-servers"},"children":["Fetching reference data for other MCP servers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a task requires IDs that other MCP servers need (price list codes, warehouse IDs, sales area IDs, VAT codes):"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_client_overview"]}," for client-level sales areas and VAT codes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["norce_config_get_store_overview"]}," for the warehouse IDs and price list IDs linked to a specific store."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These IDs can then be passed directly to the Pricing MCP, Inventory MCP, or Supplier MCP."]}]},"headings":[{"value":"Norce Config MCP — Tool Reference","id":"norce-config-mcp--tool-reference","depth":1},{"value":"A note on application IDs","id":"a-note-on-application-ids","depth":2},{"value":"Tools","id":"tools","depth":2},{"value":"List Applications","id":"list-applications","depth":3},{"value":"Get Client Overview","id":"get-client-overview","depth":3},{"value":"Get Application Overview","id":"get-application-overview","depth":3},{"value":"List Stores","id":"list-stores","depth":3},{"value":"Get Store Overview","id":"get-store-overview","depth":3},{"value":"Check Store Setup","id":"check-store-setup","depth":3},{"value":"Typical workflows","id":"typical-workflows","depth":2},{"value":"Starting a support investigation","id":"starting-a-support-investigation","depth":3},{"value":"Validating a store before go-live","id":"validating-a-store-before-go-live","depth":3},{"value":"Fetching reference data for other MCP servers","id":"fetching-reference-data-for-other-mcp-servers","depth":3}],"frontmatter":{"seo":{"title":"AI - Norce Config MCP Tool Reference","description":"Reference for all tools exposed by the Norce Config MCP Server — applications, stores, sales areas, VAT codes, and configuration validation.","keywords":"MCP, model context protocol, config MCP, applications, stores, sales areas, VAT codes, tool reference"},"metadata":{"redocly_category":"Development","owner":"MB"}},"lastModified":"2026-09-16T06:55:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/ai/norce-config-mcp-tool-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]}}