Skip to content

AI interface setup

Use the same MCP server configuration across clients. The differences are mostly where you place the config file or instruction files.

Auto-discovery If you open a workspace that contains a `dw.json` and your client supports MCP `roots/list`, the server discovers it automatically after initialization. Use docs mode first, then add credentials when you need full mode.

Environment modes

Configuration (Docs Mode)

{
  "mcpServers": {
    "sfcc-dev": {
      "command": "npx",
      "args": ["sfcc-dev-mcp"]
    }
  }
}
  • Immediate access to SFCC docs, SFRA, ISML, and cartridge generation
  • No credentials required
  • Great for onboarding and quick lookups

Universal MCP configuration

Docs-only mode:

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

Full mode:

json
{
  "mcpServers": {
    "sfcc-dev": {
      "command": "npx",
      "args": ["sfcc-dev-mcp", "--dw-json", "/path/to/dw.json", "--debug", "false"]
    }
  }
}

AI assistant setup

Configuration

{
  "mcpServers": {
    "sfcc-dev": {
      "command": "npx",
      "args": ["sfcc-dev-mcp", "--dw-json", "/path/to/dw.json", "--debug", "false"]
    }
  }
}

Inline speed

Rapid completions and edits in VS Code.

Scaffolding

Generate controllers, models, and tests.

Everyday flow

Low-friction iteration for daily work.

Verification prompts

  • Show methods on dw.catalog.Product
  • Create SFRA controller for Product-Show
  • Search job logs for failed step exceptions
  • List custom attributes on Product object

Instruction files

Available instruction files

  • copilot-instructions.md - Main instruction file for GitHub Copilot with SFCC expertise and MCP tool usage patterns
    .github/copilot-instructions.md

Setup steps

  1. Copy the instruction file from the repository to your project
  2. Place it in the .github folder of your repository
  3. Copilot automatically detects and uses these instructions
  4. The file includes SFCC development patterns, security guidance, and tool usage
Official setup guide

Verification prompts

  • "Show methods on dw.catalog.Product for pricing"
  • "Summarize the latest error log entries"
  • "Generate a cartridge named int_example"

Released under the MIT License.