diff --git a/.changeset/docs-mcp-agent-skills-refresh.md b/.changeset/docs-mcp-agent-skills-refresh.md new file mode 100644 index 00000000..58b0d467 --- /dev/null +++ b/.changeset/docs-mcp-agent-skills-refresh.md @@ -0,0 +1,5 @@ +--- +'@salesforce/b2c-dx-docs': patch +--- + +Refreshed the MCP and agent-skill documentation with clearer installation and configuration guidance, plus updated skill catalog references. \ No newline at end of file diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json index 4177d0bc..7d59aecb 100644 --- a/.claude-plugin/marketplace.json +++ b/.claude-plugin/marketplace.json @@ -39,6 +39,21 @@ "source": "./skills/b2c-experimental", "category": "productivity", "strict": false + }, + { + "name": "b2c-dx-mcp", + "description": "MCP server for AI-assisted Salesforce B2C Commerce development with project-aware tooling for common workflows.", + "author": { + "name": "Salesforce" + }, + "license": "Apache-2.0", + "category": "productivity", + "mcpServers": { + "b2c-dx-mcp": { + "command": "npx", + "args": ["-y", "@salesforce/b2c-dx-mcp@latest", "--allow-non-ga-tools"] + } + } } ] } diff --git a/docs/guide/agent-skills.md b/docs/guide/agent-skills.md index f7867ccc..35e9a4c1 100644 --- a/docs/guide/agent-skills.md +++ b/docs/guide/agent-skills.md @@ -4,26 +4,32 @@ description: AI agent skills and plugins for Claude Code, Cursor, and GitHub Cop # Agent Skills & Plugins -The B2C Developer Tooling project provides agent skills that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects. +The B2C Developer Tooling project provides agent skills and plugins that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects. -These skills follow the [Agent Skills](https://agentskills.io/home) standard and can be used with multiple agentic IDEs including [Claude Code](https://claude.ai/code), Cursor, GitHub Copilot, and VS Code. +Skills plugins follow the [Agent Skills](https://agentskills.io/home) standard and can be used with multiple agentic IDEs including [Claude Code](https://claude.ai/code), Cursor, GitHub Copilot, and VS Code. The marketplace also includes an MCP server plugin (`b2c-dx-mcp`). ## Overview -When installed, the skills teach AI assistants about B2C Commerce development, CLI commands, and best practices, enabling them to help you with: +When installed, the skills plugins teach AI assistants about B2C Commerce development, CLI commands, and best practices, enabling them to help you with: - **CLI Operations**: Deploying cartridges, running jobs, managing sandboxes, WebDAV operations - **B2C Development**: Controllers, ISML templates, forms, localization, logging, metadata - **Web Services**: HTTP/SOAP/FTP integrations using the Service Framework - **Custom APIs**: Building SCAPI Custom APIs with contracts, implementations, and mappings -## Available Plugins +## Available Skills Plugins | Plugin | Description | |--------|-------------| | `b2c-cli` | Skills for B2C CLI commands and operations | | `b2c` | Skills for B2C Commerce development patterns | +## Available MCP Plugins + +| Plugin | Description | +|--------|-------------| +| `b2c-dx-mcp` | MCP server for AI-assisted Salesforce B2C Commerce development with project-aware tooling for common workflows | + ### Plugin: b2c-cli Skills for using the B2C CLI to manage your B2C Commerce instances. Covers code deployment, job execution, site archive import/export, WebDAV file operations, On-Demand Sandbox management, and more. @@ -36,6 +42,12 @@ Skills for B2C Commerce development patterns and practices. Covers controllers, Browse skills: [skills/b2c/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/skills/b2c/skills) +### Plugin: b2c-dx-mcp + +Marketplace plugin for the B2C DX MCP server, providing AI-assisted B2C Commerce development workflows across supported MCP clients. + +For setup and configuration, see the installation sections below and MCP docs: [MCP Server Overview](/mcp/) and [MCP Installation](/mcp/installation). + ## Installation with Claude Code ### Prerequisites @@ -60,12 +72,14 @@ Install the plugins at your preferred scope: # Available only in the current project claude plugin install b2c-cli --scope project claude plugin install b2c --scope project +claude plugin install b2c-dx-mcp --scope project ``` ```bash [User Scope] # Available in all your projects claude plugin install b2c-cli --scope user claude plugin install b2c --scope user +claude plugin install b2c-dx-mcp --scope user ``` ::: @@ -76,7 +90,7 @@ claude plugin install b2c --scope user claude plugin list ``` -You should see `b2c-cli@b2c-developer-tooling` and `b2c@b2c-developer-tooling` in the list. +You should see `b2c-cli@b2c-developer-tooling`, `b2c@b2c-developer-tooling`, and `b2c-dx-mcp@b2c-developer-tooling` in the list. ### Updating Plugins @@ -86,6 +100,7 @@ To get the latest plugin updates: claude plugin marketplace update claude plugin update b2c-cli@b2c-developer-tooling claude plugin update b2c@b2c-developer-tooling +claude plugin update b2c-dx-mcp@b2c-developer-tooling ``` ### Uninstalling @@ -95,6 +110,7 @@ To remove the plugins: ```bash claude plugin uninstall b2c-cli@b2c-developer-tooling claude plugin uninstall b2c@b2c-developer-tooling +claude plugin uninstall b2c-dx-mcp@b2c-developer-tooling ``` To remove the marketplace: @@ -105,7 +121,7 @@ claude plugin marketplace remove b2c-developer-tooling ## Installation with Skills CLI -The [Skills CLI](https://github.com/vercel-labs/skills) provides a universal way to install agent skills to any supported IDE. +The [Skills CLI](https://github.com/vercel-labs/skills) provides a way to install agent skills to supported IDEs. Use this for the skills plugins (`b2c` and `b2c-cli`), not for the MCP server plugin (`b2c-dx-mcp`). ```bash # Interactive mode - select skills and IDEs diff --git a/docs/guide/index.md b/docs/guide/index.md index 707bf229..0e1875d0 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -39,16 +39,16 @@ The B2C DX MCP Server enables AI assistants to help with B2C Commerce developmen ```bash [Project Scope (Recommended)] cd /path/to/your/project -claude mcp add --transport stdio --scope project b2c-dx -- npx -y @salesforce/b2c-dx-mcp --allow-non-ga-tools +claude mcp add --transport stdio --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest --allow-non-ga-tools ``` ```bash [User Scope] -claude mcp add --transport stdio --scope user b2c-dx -- npx -y @salesforce/b2c-dx-mcp --allow-non-ga-tools +claude mcp add --transport stdio --scope user b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest --allow-non-ga-tools ``` ::: -**Cursor:** [Add to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=b2c-dx&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBzYWxlc2ZvcmNlL2IyYy1keC1tY3AiLCItLXByb2plY3QtZGlyZWN0b3J5IiwiJHt3b3Jrc3BhY2VGb2xkZXJ9IiwiLS1hbGxvdy1ub24tZ2EtdG9vbHMiXX0=) +**Cursor:** [Add to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=b2c-dx-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBzYWxlc2ZvcmNlL2IyYy1keC1tY3BAbGF0ZXN0IiwiLS1wcm9qZWN0LWRpcmVjdG9yeSIsIiR7d29ya3NwYWNlRm9sZGVyfSIsIi0tYWxsb3ctbm9uLWdhLXRvb2xzIl19) See the [MCP Server Installation Guide](/mcp/installation) for detailed setup instructions for Claude Code, Cursor, GitHub Copilot, and other MCP clients. diff --git a/docs/mcp/configuration.md b/docs/mcp/configuration.md index 1e602194..255be24b 100644 --- a/docs/mcp/configuration.md +++ b/docs/mcp/configuration.md @@ -136,7 +136,7 @@ See the [CLI Configuration guide](../guide/configuration#cli-flags) for complete ### Auto-Discovery (Default) -By default, the server automatically detects your project type and enables relevant toolsets. See [Project Type Detection](./installation#project-type-detection) for details. +By default, the server automatically detects your project type and enables relevant toolsets. See [Project Type Detection](./#project-type-detection) for details. ### Manual Selection diff --git a/docs/mcp/index.md b/docs/mcp/index.md index 55edb2a8..c5a62a21 100644 --- a/docs/mcp/index.md +++ b/docs/mcp/index.md @@ -31,6 +31,11 @@ cd /path/to/your/project claude mcp add --transport stdio --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest --allow-non-ga-tools ``` +```bash [Plugin Marketplace (Alternative)] +claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling +claude plugin install b2c-dx-mcp --scope project +``` + ```bash [User Scope] claude mcp add --transport stdio --scope user b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest --allow-non-ga-tools ``` diff --git a/docs/mcp/installation.md b/docs/mcp/installation.md index fddab6ab..00deb9b4 100644 --- a/docs/mcp/installation.md +++ b/docs/mcp/installation.md @@ -14,36 +14,7 @@ This guide covers installing and configuring the B2C DX MCP Server for various M > **Note:** For Figma-to-component tools, you also need an external Figma MCP server enabled. See [Figma-to-Component Tools Setup](./figma-tools-setup) for details. -## Installation Method - -The MCP server is installed via `npx`, which downloads and runs the latest version on demand. - -### Project Directory - -The server automatically detects your project location to enable: - -1. **Auto-discovery** - Detects your project type and enables appropriate toolsets -2. **Configuration loading** - Reads [`dw.json`](../guide/configuration#configuration-file) from your project root for B2C credentials -3. **Scaffolding** - Creates new files in the correct location based on your project structure - -**Detection methods:** -- **Cursor (project-level)**: Automatically detected from the MCP config file location -- **Cursor (user-level)**: Requires `--project-directory "${workspaceFolder}"` in the args array -- **Claude Code**: Automatically detected from the current working directory (cd into project root before installation) -- **GitHub Copilot**: Automatically detected from the workspace location - -### Project Type Detection - -The server automatically detects your project type: - -| Project Type | Detection Criteria | Enabled Toolsets | -|--------------|-------------------|------------------| -| **PWA Kit v3** | `@salesforce/pwa-kit-*`, `@salesforce/retail-react-app`, or `ccExtensibility` in package.json | PWAV3, MRT, SCAPI | -| **Storefront Next** | Root or workspace package has `@salesforce/storefront-next*` dependency, or package name starting with `storefront-next` | STOREFRONTNEXT, MRT, CARTRIDGES, SCAPI | -| **Cartridges** | `.project` file in cartridge directory | CARTRIDGES, SCAPI | -| **No project detected** | No B2C markers found | SCAPI (base toolset only) | - -Hybrid projects (e.g., cartridges + PWA Kit) get combined toolsets. +The MCP server is installed via `npx`, which downloads and runs the latest version on demand. For project directory and project type detection details, see [MCP Server Overview](./#usage). ## Claude Code @@ -56,6 +27,11 @@ cd /path/to/your/project claude mcp add --transport stdio --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest --allow-non-ga-tools ``` +```bash [Plugin Marketplace (Alternative)] +claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling +claude plugin install b2c-dx-mcp --scope project +``` + ```bash [User Scope] claude mcp add --transport stdio --scope user b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest --allow-non-ga-tools ``` diff --git a/skills/README.md b/skills/README.md index 5097dd2c..e94620d1 100644 --- a/skills/README.md +++ b/skills/README.md @@ -1,16 +1,23 @@ -# B2C CLI Agent Skills & Claude Code Plugins +# B2C Agent Skills & Claude Code Plugins -This directory contains agent skills and [Claude Code](https://claude.ai/code) plugins that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects. +This directory contains agent skills and skills-based [Claude Code](https://claude.ai/code) plugins that enhance AI-assisted development for Salesforce B2C Commerce projects. These skills follow the [Agent Skills](https://agentskills.io/home) format and can be used with multiple agentic IDEs including Claude Code, Cursor, GitHub Copilot, and OpenAI Codex. -## Available Plugins +## Available Skills Plugins | Plugin | Description | |--------|-------------| | `b2c-cli` | Skills for Salesforce B2C Commerce CLI operations | | `b2c` | B2C Commerce development skills including Custom API development guides | +## MCP Plugin + +`b2c-dx-mcp` is an MCP server plugin, not a skills plugin. For installation and configuration, see: + +- [MCP Installation Guide](../docs/mcp/installation.md) +- [MCP Overview](../docs/mcp/index.md) + ## Installation ### 1. Add the Marketplace @@ -23,17 +30,20 @@ claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling ### 2. Install the Plugin -Install the b2c-cli plugin at your preferred scope: +Install the plugins at your preferred scope: ```bash # Install for the current project only claude plugin install b2c-cli --scope project +claude plugin install b2c --scope project # Install for the current user (available in all projects) claude plugin install b2c-cli --scope user +claude plugin install b2c --scope user # Install locally (development/testing) claude plugin install b2c-cli --scope local +claude plugin install b2c --scope local ``` ### 3. Verify Installation