SFCC Dev

MCPv1
AI Interface Integration

Connect Your AI Assistants

Unified setup guide for Claude Desktop, GitHub Copilot, Cursor and any MCP-compatible client. Start in documentation-only mode then unlock real-time log & job log analysis, system & custom object exploration, and code version management with credentials.

πŸš€ Environment Modes

Switch between zero-config documentation mode and full analytics mode with a single flag.

Configuration (Docs Mode)

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

Benefits

Zero Setup

Immediate access to SFCC API docs, SFRA docs & best practices.

Fast Onboarding

Great for new devs or quick reference sessions.

Safe & Local

No credentials needed (no logs / objects).

Upgrade any time by adding --dw-json.

βš™οΈ Configuration Flags

Minimal surface area – just two flags control operating mode & diagnostics.

--dw-json <path>

Add credentials for real-time log & job log analysis, system & custom object exploration, site preference searches & code version management.

--debug <true|false>

Enable verbose internal logging for troubleshooting & development.

AI Assistant Setup

Choose your interface – configuration, strengths & verification prompts in one place.

Configuration

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

Docs-only mode: omit --dw-json. Enable verbose logging temporarily with --debug true.

Key Strengths

Inline Speed

Rapid completions & edits in VS Code.

Scaffolding

Generate controllers, models & 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

πŸ“‹ AI Instruction Files

Enhance your AI assistant's SFCC expertise with specialized instruction files that provide context about development patterns, security practices, and MCP tool usage.

Available Instruction Files

copilot-instructions.md

Main instruction file for GitHub Copilot with SFCC expertise and MCP tool usage patterns

πŸ“ View on GitHub.github/copilot-instructions.md

Setup Instructions

  1. Copy the instruction file from the repository to your project
  2. Place it in the .github folder of your repository
  3. Copilot will automatically detect and use these instructions when working in your repo
  4. The file includes SFCC development patterns, security guidelines, and MCP tool usage

Benefits

🎯 Enhanced Expertise

Pre-loaded SFCC knowledge, development patterns, and security best practices

πŸ”§ MCP Tool Awareness

Built-in knowledge of 36+ MCP tools (docs, SFRA, best practices, logs, job logs, objects, code versions)

⚑ Faster Development

Immediate access to SFCC-specific patterns without requiring context

πŸ”’ Security-First

Built-in security patterns and validation practices for SFCC development

Universal MCP Configuration

Works across any MCP-compatible AI (desktop, IDE plugin, CLI agent).

json
{
  "mcpServers": {
    "sfcc-dev": {
      "command": "npx",
      "args": ["sfcc-dev-mcp", "--dw-json", "/Users/username/sfcc-project/dw.json", "--debug", "false"]
    }
  }
}
  • --dw-json optional for docs-only mode
  • --debug set true when diagnosing tool behavior