Skip to content

Commit 1955b22

Browse files
committed
update agent skills documentation
1 parent 8b57306 commit 1955b22

3 files changed

Lines changed: 182 additions & 160 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const guideSidebar = [
99
{ text: 'Installation', link: '/guide/installation' },
1010
{ text: 'Authentication Setup', link: '/guide/authentication' },
1111
{ text: 'Configuration', link: '/guide/configuration' },
12-
{ text: 'Agent Skills & Plugins', link: '/guide/claude-code-plugin' },
12+
{ text: 'Agent Skills & Plugins', link: '/guide/agent-skills' },
1313
],
1414
},
1515
{

docs/guide/agent-skills.md

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# Agent Skills & Plugins
2+
3+
The B2C Developer Tooling project provides agent skills that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects.
4+
5+
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 OpenAI Codex.
6+
7+
## Overview
8+
9+
When installed, the skills teach AI assistants about B2C Commerce development, CLI commands, and best practices, enabling them to help you with:
10+
11+
- **CLI Operations** - Deploying cartridges, running jobs, managing sandboxes, WebDAV operations
12+
- **Custom API Development** - Building SCAPI Custom APIs with contracts, implementations, and mappings
13+
- **Best Practices** - Authentication patterns, troubleshooting workflows, and development practices
14+
15+
## Available Plugins
16+
17+
| Plugin | Description |
18+
|--------|-------------|
19+
| `b2c-cli` | Skills for B2C CLI commands and operations |
20+
| `b2c` | Skills for B2C Commerce development practices |
21+
22+
### Plugin: b2c-cli
23+
24+
Skills for using the B2C CLI to manage your Commerce Cloud instances:
25+
26+
| Skill | Description |
27+
|-------|-------------|
28+
| `b2c-code` | Code version deployment and management |
29+
| `b2c-job` | Job execution and site archive import/export (IMPEX) |
30+
| `b2c-sites` | Storefront sites listing and inspection |
31+
| `b2c-webdav` | WebDAV file operations (ls, get, put, rm, zip, unzip) |
32+
| `b2c-ods` | On-Demand Sandbox management |
33+
| `b2c-mrt` | Managed Runtime project and deployment management |
34+
| `b2c-slas` | SLAS client management |
35+
| `b2c-scapi-custom` | Custom API endpoint status and management |
36+
37+
### Plugin: b2c
38+
39+
Skills for B2C Commerce development practices and patterns:
40+
41+
| Skill | Description |
42+
|-------|-------------|
43+
| `b2c-custom-api-development` | Comprehensive guide for building SCAPI Custom APIs |
44+
45+
The Custom API development skill covers:
46+
- The three required components (contract, implementation, mapping)
47+
- OAS 3.0 schema authoring with security schemes
48+
- Implementation patterns with RESTResponseMgr
49+
- Shopper vs Admin API differences
50+
- Caching and remote includes
51+
- Circuit breaker protection
52+
- Troubleshooting workflows
53+
54+
## Installation with Claude Code
55+
56+
### Prerequisites
57+
58+
- [Claude Code](https://claude.ai/code) installed and configured
59+
60+
### Add the Marketplace
61+
62+
First, add the B2C Developer Tooling marketplace:
63+
64+
```bash
65+
claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
66+
```
67+
68+
### Install Plugins
69+
70+
Install the plugins at your preferred scope:
71+
72+
::: code-group
73+
74+
```bash [Project Scope]
75+
# Available only in the current project
76+
claude plugin install b2c-cli --scope project
77+
claude plugin install b2c --scope project
78+
```
79+
80+
```bash [User Scope]
81+
# Available in all your projects
82+
claude plugin install b2c-cli --scope user
83+
claude plugin install b2c --scope user
84+
```
85+
86+
:::
87+
88+
### Verify Installation
89+
90+
```bash
91+
claude plugin list
92+
```
93+
94+
You should see `b2c-cli@b2c-developer-tooling` and `b2c@b2c-developer-tooling` in the list.
95+
96+
### Updating Plugins
97+
98+
To get the latest plugin updates:
99+
100+
```bash
101+
claude plugin marketplace update
102+
claude plugin update b2c-cli@b2c-developer-tooling
103+
claude plugin update b2c@b2c-developer-tooling
104+
```
105+
106+
### Uninstalling
107+
108+
To remove the plugins:
109+
110+
```bash
111+
claude plugin uninstall b2c-cli@b2c-developer-tooling
112+
claude plugin uninstall b2c@b2c-developer-tooling
113+
```
114+
115+
To remove the marketplace:
116+
117+
```bash
118+
claude plugin marketplace remove b2c-developer-tooling
119+
```
120+
121+
## Installation with Other IDEs
122+
123+
The B2C skills follow the [Agent Skills](https://agentskills.io/home) standard and can be used with other AI-powered development tools.
124+
125+
### CLI Setup Command
126+
127+
::: warning Coming Soon
128+
The `b2c setup skills` command is not yet available. Use the manual method below for now.
129+
:::
130+
131+
```bash
132+
# Configure skills for your IDE (coming soon)
133+
b2c setup skills --ide cursor
134+
b2c setup skills --ide copilot
135+
```
136+
137+
### Manual Setup
138+
139+
You can manually copy skill files from the GitHub repository to your IDE's configuration:
140+
141+
- **b2c-cli skills**: [plugins/b2c-cli/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c-cli/skills)
142+
- **b2c skills**: [plugins/b2c/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c/skills)
143+
144+
#### Cursor
145+
146+
Copy the `SKILL.md` files to `.cursor/rules/` in your project or configure globally in Cursor settings.
147+
148+
#### GitHub Copilot
149+
150+
Append the skill content to `.github/copilot-instructions.md` in your repository.
151+
152+
#### OpenAI Codex
153+
154+
Configure per the OpenAI Codex documentation for custom instructions.
155+
156+
## Usage Examples
157+
158+
Once installed, you can ask your AI assistant to help with B2C Commerce tasks:
159+
160+
**Deploy code:**
161+
> "Deploy the cartridges in ./cartridges to my sandbox"
162+
163+
**Check code versions:**
164+
> "List all code versions on my instance and show which one is active"
165+
166+
**Run a job:**
167+
> "Run the reindex job on my sandbox"
168+
169+
**Manage files:**
170+
> "Download the latest log files from my instance"
171+
172+
**Create a sandbox:**
173+
> "Create a new On-Demand Sandbox with TTL of 48 hours"
174+
175+
**Check Custom API status:**
176+
> "Show me the status of my Custom API endpoints"
177+
178+
**Build a Custom API:**
179+
> "Help me create a Custom API for loyalty information"
180+
181+
The AI will use the appropriate skills and CLI commands based on your request.

docs/guide/claude-code-plugin.md

Lines changed: 0 additions & 159 deletions
This file was deleted.

0 commit comments

Comments
 (0)