Skip to content

Commit e34f596

Browse files
committed
Update agent-skills documentation to be more maintainable
- Describe plugins generally instead of listing every individual skill - Remove skill tables that would need constant updates as skills are added - Link to GitHub directories for browsing available skills - Add Cursor docs link for skills configuration - Add VS Code Agent Skills documentation link - Update usage examples to include logging and web services
1 parent 9c61f5f commit e34f596

1 file changed

Lines changed: 25 additions & 53 deletions

File tree

docs/guide/agent-skills.md

Lines changed: 25 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,54 +2,35 @@
22

33
The B2C Developer Tooling project provides agent skills that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects.
44

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.
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 VS Code.
66

77
## Overview
88

99
When installed, the skills teach AI assistants about B2C Commerce development, CLI commands, and best practices, enabling them to help you with:
1010

1111
- **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
12+
- **B2C Development** - Controllers, ISML templates, forms, localization, logging, metadata
13+
- **Web Services** - HTTP/SOAP/FTP integrations using the Service Framework
14+
- **Custom APIs** - Building SCAPI Custom APIs with contracts, implementations, and mappings
1415

1516
## Available Plugins
1617

1718
| Plugin | Description |
1819
|--------|-------------|
1920
| `b2c-cli` | Skills for B2C CLI commands and operations |
20-
| `b2c` | Skills for B2C Commerce development practices |
21+
| `b2c` | Skills for B2C Commerce development patterns |
2122

2223
### Plugin: b2c-cli
2324

24-
Skills for using the B2C CLI to manage your Commerce Cloud instances:
25+
Skills for using the B2C CLI to manage your Commerce Cloud instances. Covers code deployment, job execution, site archive import/export, WebDAV file operations, On-Demand Sandbox management, and more.
2526

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 |
27+
Browse skills: [plugins/b2c-cli/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c-cli/skills)
3628

3729
### Plugin: b2c
3830

39-
Skills for B2C Commerce development practices and patterns:
31+
Skills for B2C Commerce development patterns and practices. Covers controllers, ISML templates, forms, localization, logging, metadata, web services, custom job steps, Page Designer, Business Manager extensions, and Custom API development.
4032

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
33+
Browse skills: [plugins/b2c/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c/skills)
5334

5435
## Installation with Claude Code
5536

@@ -122,36 +103,24 @@ claude plugin marketplace remove b2c-developer-tooling
122103

123104
The B2C skills follow the [Agent Skills](https://agentskills.io/home) standard and can be used with other AI-powered development tools.
124105

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
106+
### Cursor
138107

139-
You can manually copy skill files from the GitHub repository to your IDE's configuration:
108+
See the [Cursor Skills documentation](https://cursor.com/docs/context/skills) for configuration instructions.
140109

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)
110+
Copy skill files from the plugin directories to your Cursor skills location:
143111

144-
#### Cursor
112+
- [b2c-cli skills](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c-cli/skills)
113+
- [b2c skills](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c/skills)
145114

146-
Copy the `SKILL.md` files to `.cursor/rules/` in your project or configure globally in Cursor settings.
115+
### VS Code with GitHub Copilot
147116

148-
#### GitHub Copilot
117+
See the [VS Code Agent Skills documentation](https://code.visualstudio.com/docs/copilot/customization/agent-skills) for configuration instructions.
149118

150-
Append the skill content to `.github/copilot-instructions.md` in your repository.
119+
You can also append skill content to `.github/copilot-instructions.md` in your repository.
151120

152-
#### OpenAI Codex
121+
### Other IDEs
153122

154-
Configure per the OpenAI Codex documentation for custom instructions.
123+
For other AI-powered IDEs, copy the `SKILL.md` files and any `references/` directories to your IDE's custom instructions location.
155124

156125
## Usage Examples
157126

@@ -172,10 +141,13 @@ Once installed, you can ask your AI assistant to help with B2C Commerce tasks:
172141
**Create a sandbox:**
173142
> "Create a new On-Demand Sandbox with TTL of 48 hours"
174143
175-
**Check Custom API status:**
176-
> "Show me the status of my Custom API endpoints"
177-
178144
**Build a Custom API:**
179145
> "Help me create a Custom API for loyalty information"
180146
147+
**Add logging:**
148+
> "Add logging to my checkout controller"
149+
150+
**Create a web service:**
151+
> "Create an HTTP service to call the payment gateway API"
152+
181153
The AI will use the appropriate skills and CLI commands based on your request.

0 commit comments

Comments
 (0)