Configure Credentials for the Custom API Discovery MCP Tool

Configure the B2C Commerce instance credentials so that the Custom API Discovery MCP Tool, scapi_custom_api_discovery, can authenticate to your B2C Commerce instance. Choose one of the available methods to configure your B2C Commerce credentials.

Option 1: dw.json Configuration File (Recommended)

Create a dw.json file under your PWA Kit project directory with your B2C Commerce credentials.

1{
2  "hostname": "https://your-instance.dx.commercecloud.salesforce.com",
3  "instance-id": "your-instance-id",
4  "client-id": "your-client-id",
5  "client-secret": "your-client-secret",
6  "org-id": "your-org-id",
7  "short-code": "your-short-code"
8}

If the dw.json file isn’t under your PWA Kit project directory, update your mcp.json file to point to the dw.json file path.

1{
2  "mcpServers": {
3    "pwa-kit": {
4      "command": "npx",
5      "args": ["-y", "@salesforce/pwa-kit-mcp", "--dw-json", "/path/to/your/dw.json"],
6      "env": {
7        "PWA_STOREFRONT_APP_PATH": "{{path-to-app-directory}}"
8      }
9    }
10  }
11}

The MCP server fetches dw.json locally in this order of priority.

dw.json path supplied from mcp settings args, if set.
PWA_STOREFRONT_APP_PATH/dw.json
PWA_STOREFRONT_APP_PATH/../dw.json
PWA_STOREFRONT_APP_PATH/../../dw.json

Option 2: Environment Variables

Use environment variables to set your B2C Commerce instance credentials.

1SFCC_HOSTNAME=https://your-instance.dx.commercecloud.salesforce.com
2SFCC_ORG_ID=your-org-id
3SFCC_SHORT_CODE=your-short-code
4SFCC_INSTANCE_ID=your-instance-id
5SFCC_CLIENT_ID=your-client-id
6SFCC_CLIENT_SECRET=your-client-secret

Environment variables take precedence over dw.json values if both are provided.

Note

Option 3: Local Custom API Files (Fallback for Custom API Discovery)

If B2C Commerce credentials aren’t available for the scapi_custom_api_discovery MCP tool, provide local custom API files using one of these methods.

Method 1: Provide the Path of Local Custom API Files

Set the SFCC_CARTRIDGE_PATH environment variable to point to your custom API cartridge directory.

1{
2  "mcpServers": {
3    "pwa-kit": {
4      "command": "npx",
5      "args": ["-y", "@salesforce/pwa-kit-mcp"],
6      "env": {
7        "PWA_STOREFRONT_APP_PATH": "{{path-to-app-directory}}",
8        "SFCC_CARTRIDGE_PATH": "/path/to/your/cartridge"
9      }
10    }
11  }
12}

Method 2: Auto-Discovery of Local Custom API Files

If SFCC_CARTRIDGE_PATH isn’t set, the tool automatically searches for api.json and schema.yaml files starting from PWA_STOREFRONT_APP_PATH and traversing up through parent directories until it reaches the filesystem root or home directory (maximum of 10 levels). At each directory level, it searches recursively down through subdirectories, up to 10 levels deep.

File Structure Expected

1your-custom-api-directory/
2├── api.json          # Custom API metadata
3└── schema.yaml       # OpenAPI schema (optional)

Example api.json File

1{
2  "apiName": "reviews",
3  "apiVersion": "v1",
4  "cartridgeName": "plugin_custom_api_intro",
5  "endpointPath": "reviews",
6  "httpMethod": "GET",
7  "securityScheme": "bearer",
8  "baseUrl": "https://your-shortcode.api.commercecloud.salesforce.com/custom/reviews/v1"
9}

Search Priority

The MCP server searches for local custom API files in this order.

B2C Commerce credentials in the dw.json file or environment variables.
The SFCC_CARTRIDGE_PATH environment variable. The MCP server searches recursively up to 10 levels deep in subdirectories.
The PWA_STOREFRONT_APP_PATH environment variable and up to 5 parent directories. Searches recursively up to 10 levels deep in subdirectories at each level.

Node 20 Deprecation

Node 20 has an end-of-life date of April 30, 2026. We strongly recommend that you update your production projects to Node 22 or Node 24 by upgrading to the latest minor version of PWA Kit 3.x. See full details on Node support dates and upgrade steps in Upgrade Node Version.