Configuration Guide

Configure in Minutes

Start zero-config. Add credentials only when you need log analysis, system object exploration & code version control.

🚀 Quick Start

Pick a mode, generate dw.json, run the server. Minimal friction, fast feedback.

No credentials required. Add the server to your AI client:

json

{
  "mcpServers": {
    "sfcc-dev": {
      "command": "npx",
      "args": ["sfcc-dev-mcp"]
    }
  }
}

Enables documentation, best practices & cartridge generation
Upgrade anytime by adding --dw-json

🧪 Interactive dw.json Builder

Start minimal (only hostname + username/password for runtime & job logs). Add Data API credentials when you need system & custom objects, site preferences or code version tooling.

Tips

Keep separate dw.dev.json / dw.qa.json
Use env vars to override secrets in CI
Remove unused OAuth fields to stay minimal

Toggle to include OAuth + code/site fields

Hostname *

Username *

Password *

* Required for WebDAV + log tools. Client credentials unlock Data API features.

json

{
  "hostname": "dev01-sandbox.us01.dx.commercecloud.salesforce.com",
  "username": "your-username",
  "password": "your-password"
}

Copy & save as dw.json then run with --dw-json ./dw.json

Optional – Enables Data API Tools

🔧 Data API Configuration

Required for system object definitions, custom object attribute searches, site preferences & code version tools. Not required for runtime logs or job log analysis (basic auth only). Skip entirely if you only need docs + log visibility.

Login to Account Manager (not Business Manager)
Navigate to API Client → Add API Client
Set name (e.g. SFCC Dev MCP) & generate password
Select SFCC scope and grant required roles

Total surface: 36+ specialized tools spanning documentation, best practices, SFRA, cartridge generation, runtime logs, job logs, system & custom objects, site preferences, and code versions.

Protect Credentials

🔒 Security Basics

.gitignore

bash

echo 'dw.json' >> .gitignore
echo '*.dw.json' >> .gitignore

Environment Overrides

bash

export SFCC_CLIENT_SECRET="your-secret"
export SFCC_PASSWORD="your-password"

npx sfcc-dev-mcp --dw-json /Users/username/sfcc-project/dw.json

Permissions

bash

chmod 600 dw.json
ls -la dw.json

Debug Mode

bash

npx sfcc-dev-mcp --dw-json /Users/username/sfcc-project/dw.json --debug true

Reference

📋 Key Reference Tables

Supported dw.json Fields

Field	Required For	Notes
hostname	All authenticated tools	Sandbox domain
username/password	Logs & Job Logs (WebDAV)	WebDAV auth (runtime + job log files)
client-id/secret	System & custom objects, site prefs, code versions	OCAPI Data API + code version management
code-version	Code version operations	Optional
site-id	Site-specific actions	Optional

Tool Availability by Mode

Category	Docs Only	Full Mode
Documentation	✔	✔
Best Practices	✔	✔
SFRA Docs	✔	✔
Cartridge Generation	✔	✔
Log Analysis (runtime)	—	✔
Job Logs	—	✔
System & Custom Objects / Site Prefs	—	✔
Code Versions	—	✔

Common Issues

🐛 Troubleshooting

Auth Failed

Verify hostname format
Check username/password
Match client-id/secret
Run with --debug

dw.json Missing

Add --dw-json /Users/username/sfcc-project/dw.json
Create file in current dir
Use env vars instead
Check permissions (600)

System Object Denied

Complete Data API config
Verify resource IDs
Ensure (**) attributes
Check client roles

🔗 Next Steps

Pick your next path—feature surface or concrete tool list.

Features Overview→Available Tools