SFCC Development MCP Server

![npm version](https://badge.fury.io/js/sfcc-dev-mcp)
![License: MIT](https://opensource.org/licenses/MIT)

An AI-powered Model Context Protocol (MCP) server that provides comprehensive access to Salesforce B2C Commerce Cloud development tools, documentation, and best practices.

✨ Key Features

- 🔍 Complete SFCC Documentation Access - Search and explore all SFCC API classes and methods
- 📚 Best Practices Guides - Curated development guidelines for cartridges, hooks, controllers, client-side JavaScript, and more
- 🏗️ SFRA Documentation - Enhanced access to Storefront Reference Architecture documentation
- 📊 Log Analysis Tools - Real-time error monitoring, debugging, and job log analysis for SFCC instances
- ⚙️ System Object Definitions - Explore custom attributes and site preferences
- 🚀 Cartridge Generation - Automated cartridge structure creation

🚀 Quick Start

$3

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

$3

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

Create a dw.jsonfile with your SFCC credentials:`json { "hostname": "your-instance.sandbox.us01.dx.commercecloud.salesforce.com", "username": "your-username", "password": "your-password", "client-id": "your-client-id", "client-secret": "your-client-secret" }`

`🎯 Operating Modes`

| Mode | Tools Available | SFCC Credentials Required | |------|----------------|---------------------------| | Documentation-Only | 15 tools | ❌ No | | Full Mode | 36 tools | ✅ Yes |

`$3`


Perfect for learning and development - no SFCC instance required:
- Complete SFCC API documentation (5 tools)
- Best practices guides (4 tools) – cartridges, client-side JavaScript, controllers, hooks, security/performance 
- SFRA documentation (5 tools)
- Cartridge generation (1 tool)
$3

Complete development experience with live SFCC instance access:
- All documentation-only features (15 tools)
- Real-time log analysis (13 tools)
- System object definitions (6 tools)
- Code version management (2 tools)
� Architecture Overview
This server is built around a capability-gated, modular handler architecture that cleanly separates tool routing from domain logic:
$3

- Tool Definitions (

src/core/tool-definitions.ts

): Declarative schemas grouped by category (documentation, best practices, SFRA, logs, job logs, system objects, cartridge generation, code versions).
- Handlers (

src/core/handlers/*.ts): Each category has a handler extending a common base for timing, structured logging, and error normalization (e.g. log-handler, docs-handler, system-object-handler

).
- Clients (

src/clients/

): Encapsulate domain operations (OCAPI, SFRA docs, best practices, modular log analysis). Handlers delegate to these so orchestration and computation remain separate.
- Services (

src/services/

): Dependency-injected abstractions for filesystem and path operations — improves testability and isolates side effects.
- Modular Log System (

src/clients/logs/

): Reader (range/tail optimization), discovery, processor (line → structured entry), analyzer (patterns & health), formatter (human output) for maintainable evolution.
- Configuration Factory (

src/config/configuration-factory.ts): Determines capabilities (canAccessLogs, canAccessOCAPI

) based on provided credentials and filters exposed tools accordingly (principle of least privilege).
$3

- Extensibility: Adding a new tool usually means adding a schema + minimal handler logic (or a new handler if a new domain).
- Security: Tools that require credentials are never exposed when capability flags are false.
- Testability: Unit tests target clients & modules; integration/MCP tests validate handler routing and response structure.
- Performance: Tail log reads + lightweight caching (

cache.ts, log-cache.ts

) reduce unnecessary I/O.
$3

1. Add schema object to the correct exported array in

tool-definitions.ts

.
2. Implement domain logic in a client/service (avoid bloating handlers).
3. Extend an existing handler or create a new one if it's a new category.
4. (Only for a new category) register the new handler inside

registerHandlers() in server.ts

.
5. Discover actual response shape with

npx mcp-aegis query

 before writing tests.
6. Add Jest unit tests + YAML MCP tests (docs vs full mode if credentials required).
7. Update documentation (Development Guide + README counts if changed).
> For a deeper internal view, see the Development Guide in the docs site.
�🤖 AI Interface Setup
Choose your preferred AI assistant:
| Interface | Best For | Setup Guide |
|-----------|----------|-------------|
| Claude Desktop | Multi-turn conversations, debugging | 📖 Setup Guide |
| GitHub Copilot | VS Code integration, inline suggestions | 📖 Setup Guide |
| Cursor | Modern AI-powered editor | 📖 Setup Guide |
📦 Installation
$3

> Tip: Add

-y (or --yes

) to suppress the interactive prompt npx shows before downloading a package. This prevents AI clients (Claude Desktop, Copilot, Cursor) from hanging waiting for confirmation.

bash
Test the server

npx -y sfcc-dev-mcp
Use with your configuration

npx -y sfcc-dev-mcp --dw-json /path/to/your/dw.json

$3

bash
npm install -g sfcc-dev-mcp
sfcc-dev-mcp --dw-json /path/to/your/dw.json


🐛 Debug Mode & Logging
$3

bash
Enable debug mode for detailed logging

npx -y sfcc-dev-mcp --debug
Or with configuration file

npx -y sfcc-dev-mcp --dw-json /path/to/your/dw.json --debug


$3
The server writes logs to your system's temporary directory:

- macOS: /var/folders/{user-id}/T/sfcc-mcp-logs/- Linux:/tmp/sfcc-mcp-logs/- Windows:%TEMP%\sfcc-mcp-logs\

Log Files Created: -sfcc-mcp-info.log- General application logs and startup messages -sfcc-mcp-debug.log - Detailed debug information (only when --debugis enabled) -sfcc-mcp-error.log- Error messages and stack traces -sfcc-mcp-warn.log - Warning messages

`$3`

javascript
// The exact path varies by system - to find yours:
node -e "console.log(require('os').tmpdir() + '/sfcc-mcp-logs')"
📖 Documentation
📚 Complete Documentation - Comprehensive guides and references
Quick Links:
- Installation Guide - Detailed installation options
- AI Interface Setup - Configure Claude Desktop, GitHub Copilot, or Cursor
- Configuration Guide - SFCC credentials and Data API setup
- Available Tools - Complete tool reference
- Examples - Real-world usage patterns
- Troubleshooting - Common issues and solutions
🛠️ Example AI Interactions

`🧑‍💻 "Create a new SFCC controller for product search" 🤖 Generates complete controller with proper imports, route handling, and SFRA patterns

🧑‍💻 "What's wrong with my checkout flow? Check the logs" 🤖 Analyzes recent error logs, identifies issues, and suggests fixes

🧑‍💻 "Show me how to implement OCAPI hooks for order validation" 🤖 Provides best practices guide with complete hook implementation examples``

🔒 Security Notes

- Local Development Focus: Designed for individual developer use on local machines
- Credential Protection: dw.json files should never be committed to version control
- Network Security: All API calls use HTTPS with proper authentication
- No Data Storage: Server doesn't persist any SFCC data locally

🔮 Future Plans

We're continuously improving the SFCC Development MCP Server with exciting new features planned:

$3

- 🧠 Smarter Log Fetching - Enhanced log analysis with intelligent filtering, pattern recognition, and contextual error correlation
- 🚀 Deployment Tools - Integration with SFCC deployment processes and code version management

$3

Have ideas for new features or improvements? We'd love to hear from you!

- 💡 Feature Requests: Open an issue to discuss your ideas
- 🐛 Bug Reports: Help us improve by reporting any issues you encounter
- 🔧 Pull Requests: Contribute code, documentation, or examples
- 📚 Documentation: Help expand our guides and best practices

Check out our Contributing Guide to get started, or browse our open issues to see where you can help.

Your expertise and feedback make this tool better for the entire SFCC community!

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🚀 Ready to supercharge your SFCC development with AI?

📖 Get Started with the Full Documentation

SFCC Development MCP Server

![npm version](https://badge.fury.io/js/sfcc-dev-mcp)
![License: MIT](https://opensource.org/licenses/MIT)

An AI-powered Model Context Protocol (MCP) server that provides comprehensive access to Salesforce B2C Commerce Cloud development tools, documentation, and best practices.

✨ Key Features

🚀 Quick Start

$3

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

$3

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

`🎯 Operating Modes`

| Mode | Tools Available | SFCC Credentials Required | |------|----------------|---------------------------| | Documentation-Only | 15 tools | ❌ No | | Full Mode | 36 tools | ✅ Yes |

`$3`


Perfect for learning and development - no SFCC instance required:
- Complete SFCC API documentation (5 tools)
- Best practices guides (4 tools) – cartridges, client-side JavaScript, controllers, hooks, security/performance 
- SFRA documentation (5 tools)
- Cartridge generation (1 tool)
$3

Complete development experience with live SFCC instance access:
- All documentation-only features (15 tools)
- Real-time log analysis (13 tools)
- System object definitions (6 tools)
- Code version management (2 tools)
� Architecture Overview
This server is built around a capability-gated, modular handler architecture that cleanly separates tool routing from domain logic:
$3

- Tool Definitions (

src/core/tool-definitions.ts

): Declarative schemas grouped by category (documentation, best practices, SFRA, logs, job logs, system objects, cartridge generation, code versions).
- Handlers (

src/core/handlers/*.ts): Each category has a handler extending a common base for timing, structured logging, and error normalization (e.g. log-handler, docs-handler, system-object-handler

).
- Clients (

src/clients/

): Encapsulate domain operations (OCAPI, SFRA docs, best practices, modular log analysis). Handlers delegate to these so orchestration and computation remain separate.
- Services (

src/services/

): Dependency-injected abstractions for filesystem and path operations — improves testability and isolates side effects.
- Modular Log System (

src/clients/logs/

): Reader (range/tail optimization), discovery, processor (line → structured entry), analyzer (patterns & health), formatter (human output) for maintainable evolution.
- Configuration Factory (

src/config/configuration-factory.ts): Determines capabilities (canAccessLogs, canAccessOCAPI

) based on provided credentials and filters exposed tools accordingly (principle of least privilege).
$3

- Extensibility: Adding a new tool usually means adding a schema + minimal handler logic (or a new handler if a new domain).
- Security: Tools that require credentials are never exposed when capability flags are false.
- Testability: Unit tests target clients & modules; integration/MCP tests validate handler routing and response structure.
- Performance: Tail log reads + lightweight caching (

cache.ts, log-cache.ts

) reduce unnecessary I/O.
$3

1. Add schema object to the correct exported array in

tool-definitions.ts

.
2. Implement domain logic in a client/service (avoid bloating handlers).
3. Extend an existing handler or create a new one if it's a new category.
4. (Only for a new category) register the new handler inside

registerHandlers() in server.ts

.
5. Discover actual response shape with

npx mcp-aegis query

 before writing tests.
6. Add Jest unit tests + YAML MCP tests (docs vs full mode if credentials required).
7. Update documentation (Development Guide + README counts if changed).
> For a deeper internal view, see the Development Guide in the docs site.
�🤖 AI Interface Setup
Choose your preferred AI assistant:
| Interface | Best For | Setup Guide |
|-----------|----------|-------------|
| Claude Desktop | Multi-turn conversations, debugging | 📖 Setup Guide |
| GitHub Copilot | VS Code integration, inline suggestions | 📖 Setup Guide |
| Cursor | Modern AI-powered editor | 📖 Setup Guide |
📦 Installation
$3

> Tip: Add

-y (or --yes

) to suppress the interactive prompt npx shows before downloading a package. This prevents AI clients (Claude Desktop, Copilot, Cursor) from hanging waiting for confirmation.

bash
Test the server

npx -y sfcc-dev-mcp
Use with your configuration

npx -y sfcc-dev-mcp --dw-json /path/to/your/dw.json

$3

bash
npm install -g sfcc-dev-mcp
sfcc-dev-mcp --dw-json /path/to/your/dw.json


🐛 Debug Mode & Logging
$3

bash
Enable debug mode for detailed logging

npx -y sfcc-dev-mcp --debug
Or with configuration file

npx -y sfcc-dev-mcp --dw-json /path/to/your/dw.json --debug


$3
The server writes logs to your system's temporary directory:

- macOS: /var/folders/{user-id}/T/sfcc-mcp-logs/- Linux:/tmp/sfcc-mcp-logs/- Windows:%TEMP%\sfcc-mcp-logs\

`$3`

javascript
// The exact path varies by system - to find yours:
node -e "console.log(require('os').tmpdir() + '/sfcc-mcp-logs')"
📖 Documentation
📚 Complete Documentation - Comprehensive guides and references
Quick Links:
- Installation Guide - Detailed installation options
- AI Interface Setup - Configure Claude Desktop, GitHub Copilot, or Cursor
- Configuration Guide - SFCC credentials and Data API setup
- Available Tools - Complete tool reference
- Examples - Real-world usage patterns
- Troubleshooting - Common issues and solutions
🛠️ Example AI Interactions

`🧑‍💻 "Create a new SFCC controller for product search" 🤖 Generates complete controller with proper imports, route handling, and SFRA patterns

🧑‍💻 "What's wrong with my checkout flow? Check the logs" 🤖 Analyzes recent error logs, identifies issues, and suggests fixes

🧑‍💻 "Show me how to implement OCAPI hooks for order validation" 🤖 Provides best practices guide with complete hook implementation examples``

🔒 Security Notes

🔮 Future Plans

We're continuously improving the SFCC Development MCP Server with exciting new features planned:

$3

Have ideas for new features or improvements? We'd love to hear from you!

Check out our Contributing Guide to get started, or browse our open issues to see where you can help.

Your expertise and feedback make this tool better for the entire SFCC community!

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🚀 Ready to supercharge your SFCC development with AI?

📖 Get Started with the Full Documentation