Skip to content
View as Markdown
View as Markdown

Bundle Deployment

MCP tools for building and deploying Managed Runtime (MRT) bundles for PWA Kit and Storefront Next. Available in the MRT, PWAV3, and STOREFRONTNEXT toolsets.

mrt_bundle_push

Bundles a pre-built PWA Kit or Storefront Next project and pushes it to Managed Runtime (MRT). Optionally deploys to a target environment after push. The project must already be built (e.g., npm run build completed).

Authentication

This tool reads MRT credentials from the same sources as the CLI.

Logical valueRequiredFlagEnvironment variabledw.json fieldOther source
MRT project slugYes--projectMRT_PROJECTmrtProject-
MRT API keyYes--api-keyMRT_API_KEYmrtApiKeyapi_key in ~/.mobify
MRT environmentOnly when deploy: true--environmentMRT_ENVIRONMENTmrtEnvironment-
MRT cloud originNo--cloud-originMRT_CLOUD_ORIGINmrtCloudOriginUses ~/.mobify--{hostname} with --cloud-origin

Configuration priority: Flags → Environment variables → Config files (dw.json, ~/.mobify)

See MRT Credentials for complete setup details. See Authentication Setup for how to get your API key.

Parameters

Defaults for buildDirectory, ssrOnly, and ssrShared are chosen by detected project type (Storefront Next, PWA Kit v3, or generic). Explicit parameters override the project-type defaults.

ParameterTypeRequiredDefaultDescription
buildDirectorystringNobuildPath to build directory containing the built project files. Can be absolute or relative to the project directory.
messagestringNoNoneDeployment message to include with the bundle push. Useful for tracking deployments.
ssrOnlystringNoVaries by project typeGlob patterns for server-only files (SSR), comma-separated or JSON array. These files are only included in the server bundle.
ssrSharedstringNoVaries by project typeGlob patterns for shared files, comma-separated or JSON array. These files are included in both server and client bundles.
deploybooleanNofalseWhether to deploy to an environment after push. When true, environment must be provided via --environment flag or MRT_ENVIRONMENT.

Default values by project type

When buildDirectory, ssrOnly, or ssrShared are omitted, the tool detects the project type and applies these defaults:

Generic (used when no project type is detected; matches CLI b2c mrt bundle deploy defaults):

  • buildDirectory: build
  • ssrOnly: ssr.js, ssr.mjs, server/**/*
  • ssrShared: static/**/*, client/**/*

PWA Kit v3:

  • buildDirectory: build
  • ssrOnly: ssr.js, ssr.js.map, node_modules/**/*.*
  • ssrShared: static/ico/favicon.ico, static/robots.txt, **/*.js, **/*.js.map, **/*.json

Storefront Next:

  • buildDirectory: build
  • ssrOnly: server/**/*, loader.js, streamingHandler.{js,mjs,cjs}, streamingHandler.{js,mjs,cjs}.map, ssr.{js,mjs,cjs}, ssr.{js,mjs,cjs}.map, !static/**/*, sfnext-server-*.mjs, plus exclusions for Storybook and test files
  • ssrShared: client/**/*, static/**/*, **/*.css, image/font extensions, plus exclusions for Storybook and test files

Usage

Push a bundle without deploying:

Push the bundle from build directory to Managed Runtime.

Push a bundle and deploy to staging with a deployment message:

Build and push my Storefront Next bundle to staging with a deployment message.

Returns: {bundleId, projectSlug, target, deployed, message}

See also

Released under the Apache-2.0 License.