You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/mcp/figma-tools-setup.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Prerequisites and setup for Figma-to-component tools (workflow orch
4
4
5
5
# Figma-to-Component Tools Setup
6
6
7
-
Prerequisites and setup for using the Figma workflow tools: `storefront_next_figma_to_component_workflow`, `storefront_next_generate_component`, and `storefront_next_map_tokens_to_theme`.
7
+
Prerequisites and setup for using the Figma workflow tools: `sfnext_start_figma_workflow`, `sfnext_analyze_component`, and `sfnext_match_tokens_to_theme`.
8
8
9
9
> **Note:** 🚧 This MCP tool is for Storefront Next. Storefront Next is part of a closed pilot and isn't available for general use.
10
10
@@ -15,7 +15,7 @@ The Figma-to-component workflow requires an **external Figma MCP server** to fet
15
15
**Prerequisites:**
16
16
- b2c-dx-mcp configured with `--allow-non-ga-tools` flag (Figma tools are preview)
17
17
- Storefront Next project
18
-
-`app.css` theme file (required for `storefront_next_map_tokens_to_theme` tool; optional path can be provided)
18
+
-`app.css` theme file (required for `sfnext_match_tokens_to_theme` tool; optional path can be provided)
19
19
- External Figma MCP server enabled in your MCP client
20
20
21
21
See [Installation](./installation) for b2c-dx-mcp setup.
@@ -49,8 +49,8 @@ If the Figma MCP server is not enabled, the workflow tool will still return inst
Copy file name to clipboardExpand all lines: docs/mcp/tools/pwakit-get-guidelines.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
description: Get PWA Kit v3 development guidelines and best practices for React, Chakra UI, and Commerce API.
3
3
---
4
4
5
-
# pwakit_development_guidelines
5
+
# pwakit_get_guidelines
6
6
7
7
Returns critical architecture rules, coding standards, and best practices for building PWA Kit v3 applications with React, Chakra UI, and Commerce API.
8
8
9
9
## Overview
10
10
11
-
The `pwakit_development_guidelines` tool provides essential development guidance for PWA Kit v3. It:
11
+
The `pwakit_get_guidelines` tool provides essential development guidance for PWA Kit v3. It:
12
12
13
13
1. Returns comprehensive guidelines by default (quick-reference plus key sections).
14
14
2. Supports retrieving specific topic sections on demand.
Copy file name to clipboardExpand all lines: docs/mcp/tools/scapi-custom-api-generate-scaffold.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,19 @@
2
2
description: Generate a new custom SCAPI endpoint (OAS 3.0 schema, api.json, script.js) in an existing cartridge.
3
3
---
4
4
5
-
# scapi_custom_api_scaffold
5
+
# scapi_custom_api_generate_scaffold
6
6
7
7
Generate a new custom SCAPI endpoint in an existing cartridge. Creates `schema.yaml` (OAS 3.0 contract), `api.json` (endpoint mapping), and `script.js` (implementation) under the cartridge's `rest-apis/<apiName>/` directory.
8
8
9
9
## Overview
10
10
11
-
The `scapi_custom_api_scaffold` tool scaffolds a new custom API using the B2C tooling SDK's `custom-api` scaffold. It:
11
+
The `scapi_custom_api_generate_scaffold` tool scaffolds a new custom API using the B2C tooling SDK's `custom-api` scaffold. It:
12
12
13
13
- Creates an OpenAPI 3.0 schema, API manifest, and script stub in your project.
14
14
- Uses the first cartridge found in the project if you don't specify one.
15
15
- Supports **shopper** (siteId, customer-facing) or **admin** (no siteId) API types.
16
16
17
-
**No instance or OAuth required** — this tool works locally and only writes files into your project. To check registration status after deployment, use [`scapi_custom_apis_status`](./scapi-custom-apis-status).
17
+
**No instance or OAuth required** — this tool works locally and only writes files into your project. To check registration status after deployment, use [`scapi_custom_apis_get_status`](./scapi-custom-apis-get-status).
18
18
19
19
## Parameters
20
20
@@ -78,15 +78,15 @@ Returns the scaffold ID, output directory, and list of created files:
78
78
1.**Edit**`schema.yaml` to define paths, request/response schemas, and operation IDs.
79
79
2.**Edit**`script.js` to implement the endpoint logic.
80
80
3.**Deploy** the cartridge to your instance and **activate** the code version to register the API.
81
-
4.**Verify** with [`scapi_custom_apis_status`](./scapi-custom-apis-status) that endpoints show as `active`.
81
+
4.**Verify** with [`scapi_custom_apis_get_status`](./scapi-custom-apis-get-status) that endpoints show as `active`.
82
82
83
83
Shopper APIs are available at:
84
84
`https://{shortCode}.api.commercecloud.salesforce.com/custom/{apiName}/v1/organizations/{organizationId}/...` and require the `siteId` query parameter and ShopperToken authentication.
85
85
86
86
## Related Tools
87
87
88
88
- Part of the [SCAPI](../toolsets#scapi), [PWAV3](../toolsets#pwav3), and [STOREFRONTNEXT](../toolsets#storefrontnext) toolsets
89
-
-[`scapi_custom_apis_status`](./scapi-custom-apis-status) — Check custom API endpoint registration status after deployment
89
+
-[`scapi_custom_apis_get_status`](./scapi-custom-apis-get-status) — Check custom API endpoint registration status after deployment
90
90
-[`scapi_schemas_list`](./scapi-schemas-list) — List or fetch custom API schemas (use `apiFamily: "custom"`)
Copy file name to clipboardExpand all lines: docs/mcp/tools/scapi-custom-apis-get-status.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
description: Check the registration status of custom SCAPI endpoints deployed on your B2C Commerce instance.
3
3
---
4
4
5
-
# scapi_custom_apis_status
5
+
# scapi_custom_apis_get_status
6
6
7
7
List custom SCAPI endpoint registration status (active/not_registered). Returns one row per endpoint per site with detailed status information.
8
8
9
9
## Overview
10
10
11
11
Checks the registration status of custom API endpoints deployed on your B2C Commerce instance. Returns endpoint status (`active` or `not_registered`) with per-site details.
12
12
13
-
**Note:** This tool queries your live instance. For schema definitions, use [`scapi_schemas_list`](./scapi-schemas-list) with `apiFamily: "custom"`. To create a new custom API, use [`scapi_custom_api_scaffold`](./scapi-custom-api-scaffold).
13
+
**Note:** This tool queries your live instance. For schema definitions, use [`scapi_schemas_list`](./scapi-schemas-list) with `apiFamily: "custom"`. To create a new custom API, use [`scapi_custom_api_generate_scaffold`](./scapi-custom-api-generate-scaffold).
Copy file name to clipboardExpand all lines: docs/mcp/tools/scapi-schemas-list.md
+8-15Lines changed: 8 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ The `scapi_schemas_list` tool provides two modes of operation.
13
13
1.**List (Discovery)**: Browse available schemas without fetching full OpenAPI specs.
14
14
2.**Fetch**: Retrieve complete OpenAPI schema for a specific API.
15
15
16
-
This tool works with both standard SCAPI (Shop, Admin, Shopper APIs) and custom APIs. For endpoint registration status, use [`scapi_custom_apis_status`](./scapi-custom-apis-status) instead.
16
+
This tool works with both standard SCAPI (Shop, Admin, Shopper APIs) and custom APIs. For endpoint registration status, use [`scapi_custom_apis_get_status`](./scapi-custom-apis-get-status) instead.
17
17
18
18
## Authentication
19
19
@@ -48,12 +48,6 @@ Omit `includeSchemas` or any identifier to browse available schemas:
48
48
-`availableApiNames` - List of available API names
49
49
-`availableApiVersions` - List of available API versions
50
50
51
-
**Example prompts:**
52
-
- ✅ "Use the MCP tool to list all available SCAPI schemas."
53
-
- ✅ "Use the MCP tool to show me what checkout APIs exist." → `apiFamily: "checkout"`
54
-
- ✅ "Use the MCP tool to discover SCAPI product endpoints." → `apiFamily: "product"`
55
-
- ✅ "Use the MCP tool to list custom API definitions." → `apiFamily: "custom"`
56
-
57
51
### Fetch Mode
58
52
59
53
Set `includeSchemas: true` and provide all three identifiers (`apiFamily`, `apiName`, `apiVersion`) to fetch a complete OpenAPI schema:
@@ -62,11 +56,6 @@ Set `includeSchemas: true` and provide all three identifiers (`apiFamily`, `apiN
62
56
- Full OpenAPI schema specification
63
57
- Use `expandAll: true` to get the complete schema without collapsing
64
58
65
-
**Example prompts:**
66
-
- ✅ "Use the MCP tool to get the OpenAPI schema for shopper-baskets v1." → `apiFamily: "shopper"`, `apiName: "shopper-baskets"`, `apiVersion: "v1"`, `includeSchemas: true`
67
-
- ✅ "Use the MCP tool to show me the full OpenAPI spec for shopper-products v1." → `includeSchemas: true`, `expandAll: true`
68
-
- ✅ "Use the MCP tool to show me the loyalty-points custom API schema." → `apiFamily: "custom"`, `apiName: "loyalty-points"`, `apiVersion: "v1"`, `includeSchemas: true`
69
-
70
59
## Usage Examples
71
60
72
61
### Standard SCAPI Discovery
@@ -83,6 +72,10 @@ Filter by API family:
83
72
Use the MCP tool to show me what checkout APIs exist.
84
73
```
85
74
75
+
```
76
+
Use the MCP tool to discover SCAPI product endpoints.
77
+
```
78
+
86
79
### Custom API Discovery
87
80
88
81
List custom API definitions:
@@ -154,13 +147,13 @@ Use the MCP tool to show me the full OpenAPI spec for shopper-products v1.
154
147
155
148
- Part of the [SCAPI](../toolsets#scapi), [PWAV3](../toolsets#pwav3), and [STOREFRONTNEXT](../toolsets#storefrontnext) toolsets
156
149
- Always enabled (base toolset)
157
-
- For endpoint registration status, use [`scapi_custom_apis_status`](./scapi-custom-apis-status)
150
+
- For endpoint registration status, use [`scapi_custom_apis_get_status`](./scapi-custom-apis-get-status)
158
151
159
152
## See Also
160
153
161
154
-[SCAPI Toolset](../toolsets#scapi) - Overview of SCAPI discovery tools
162
-
-[scapi_custom_apis_status](./scapi-custom-apis-status) - Check custom API endpoint registration status
163
-
-[scapi_custom_api_scaffold](./scapi-custom-api-scaffold) - Generate a new custom API in a cartridge
155
+
-[scapi_custom_apis_get_status](./scapi-custom-apis-get-status) - Check custom API endpoint registration status
156
+
-[scapi_custom_api_generate_scaffold](./scapi-custom-api-generate-scaffold) - Generate a new custom API in a cartridge
164
157
-[Authentication Setup](../../guide/authentication#scapi-authentication) - Set up SCAPI authentication with required roles and scopes
Copy file name to clipboardExpand all lines: docs/mcp/tools/sfnext-add-page-designer-decorator.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
description: Add Page Designer decorators to React components for Storefront Next to make them available in Page Designer.
3
3
---
4
4
5
-
# storefront_next_page_designer_decorator
5
+
# sfnext_add_page_designer_decorator
6
6
7
7
Adds Page Designer decorators (`@Component`, `@AttributeDefinition`, `@RegionDefinition`) to React components to make them available in Page Designer for Storefront Next.
8
8
9
9
> **Note:** 🚧 This MCP tool is for Storefront Next. Storefront Next is part of a closed pilot and isn't available for general use.
10
10
11
11
## Overview
12
12
13
-
The `storefront_next_page_designer_decorator` tool analyzes React components and generates Page Designer decorators that enable components to be used in Page Designer. It supports two modes:
13
+
The `sfnext_add_page_designer_decorator` tool analyzes React components and generates Page Designer decorators that enable components to be used in Page Designer. It supports two modes:
14
14
15
15
1.**Auto Mode**: Quick setup with sensible defaults-automatically selects suitable props, infers types, and generates decorators immediately.
16
16
2.**Interactive Mode**: Multi-step workflow for fine-tuned control over decorator configuration.
Copy file name to clipboardExpand all lines: docs/mcp/tools/sfnext-analyze-component.md
+28-26Lines changed: 28 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,28 @@
1
1
---
2
-
description: Analyze Figma design and discovered components to recommend REUSE, EXTEND, or CREATE strategy.
2
+
description: Analyze design and discovered components to recommend REUSE, EXTEND, or CREATE strategy.
3
3
---
4
4
5
-
# storefront_next_generate_component
5
+
# sfnext_analyze_component
6
6
7
-
Analyzes Figma design and discovered components to recommend a component generation strategy. Returns a REUSE, EXTEND, or CREATE action with confidence score, key differences, and suggested implementation approach.
7
+
Analyzes design and discovered components to recommend a component generation strategy. Returns a REUSE, EXTEND, or CREATE action with confidence score, key differences, and suggested implementation approach.
8
8
9
9
> **Note:** 🚧 This MCP tool is for Storefront Next. Storefront Next is part of a closed pilot and isn't available for general use.
10
10
11
11
## Overview
12
12
13
-
The `storefront_next_generate_component` tool compares Figma-generated React code against existing components discovered in the codebase. It analyzes differences across styling, structure, behavior, and props, then recommends the best approach:
13
+
The `sfnext_analyze_component` tool compares design React code (e.g., from Figma, design handoff, or other sources) against existing components discovered in the codebase. It analyzes differences across styling, structure, behavior, and props, then recommends the best approach:
14
14
15
15
-**REUSE**: Use existing component with props or minor styling adjustments
16
16
-**EXTEND**: Extend existing component via props, variant, or composition pattern
17
17
-**CREATE**: Create a new component (reference existing patterns if applicable)
18
18
19
-
**Workflow position:** Call this tool **after** retrieving Figma design data and discovering similar components. It is a required step in the Figma-to-component workflow.
19
+
**Workflow position:** Call this tool **after** retrieving design data and discovering similar components. It is a required step in the Figma-to-component workflow.
20
20
21
21
This tool is part of the STOREFRONTNEXT toolset.
22
22
23
23
## Prerequisites
24
24
25
-
-Figma design data retrieved via Figma MCP tools
25
+
-Design React code (from Figma MCP, design handoff, or other sources)
26
26
- Component discovery performed before calling
27
27
- Storefront Next project
28
28
@@ -32,9 +32,9 @@ See [Figma-to-Component Tools Setup](../figma-tools-setup) for complete prerequi
32
32
33
33
| Parameter | Type | Required | Description |
34
34
|-----------|------|----------|-------------|
35
-
|`figmaMetadata`| string | Yes | JSON string containing Figma design metadata from `mcp__figma__get_metadata`. Can be empty string if metadata was not fetched. |
|`componentName`| string | Yes | Suggested name for the component extracted from the Figma design. |
35
+
|`figmaMetadata`| string | Yes | JSON string containing design metadata (from Figma MCP or empty). Can be empty string if metadata was not fetched. |
36
+
|`figmaCode`| string | Yes | React code from design (e.g., from Figma `mcp__figma__get_design_context`, or design handoff). |
37
+
|`componentName`| string | Yes | Suggested name for the component extracted from the design. |
38
38
|`discoveredComponents`| array | Yes | Array of similar components discovered using Glob/Grep/Read. Pass empty array if no similar components found. |
39
39
|`workspacePath`| string | No | Optional workspace root path. Defaults to the MCP server project directory. |
40
40
@@ -50,6 +50,23 @@ Each item in `discoveredComponents` must have:
50
50
|`matchType`| string | One of `'name'`, `'structure'`, `'visual'`|
51
51
|`code`| string | Full source code of the component |
52
52
53
+
## Usage Examples
54
+
55
+
### With Figma design URL
56
+
57
+
```
58
+
I have a Figma design at [URL]. Use the MCP tool to fetch the design code, search the codebase for similar components, then analyze and recommend whether to reuse, extend, or create a component.
59
+
```
60
+
61
+
### With design code already fetched
62
+
63
+
```
64
+
Use the MCP tool to analyze this design and recommend reuse, extend, or create. Design code: [paste React/JSX from Figma or design handoff]. Search the codebase for similar components first, then call the tool with the discovered components.
65
+
```
66
+
67
+
### Agent workflow note
68
+
69
+
When the agent searches the codebase and finds no similar components, it should still call the tool with `discoveredComponents: []` to get a CREATE recommendation. The user does not need to specify this—the agent discovers it during the workflow.
53
70
54
71
## Output
55
72
@@ -62,25 +79,10 @@ Returns a formatted recommendation including:
62
79
-**Suggested Approach**: Implementation guidance
63
80
-**Next Steps**: Action-specific instructions
64
81
65
-
## Usage Examples
66
-
67
-
### With Discovered Components
68
-
69
-
```
70
-
Use the MCP tool to analyze the Figma design and recommend whether to reuse, extend, or create a component. I've discovered PrimaryButton and SecondaryButton as similar components.
71
-
```
72
-
73
-
### No Similar Components
74
-
75
-
```
76
-
Use the MCP tool to analyze the Figma design. No similar components were found in the codebase.
77
-
```
78
-
79
-
80
82
## Related Tools
81
83
82
-
-[`storefront_next_figma_to_component_workflow`](./storefront-next-figma-to-component-workflow) - Call first to get workflow instructions and Figma parameters
83
-
-[`storefront_next_map_tokens_to_theme`](./storefront-next-map-tokens-to-theme) - Map Figma design tokens to theme variables
84
+
-[`sfnext_start_figma_workflow`](./sfnext-start-figma-workflow) - Call first to get workflow instructions and Figma parameters
85
+
-[`sfnext_match_tokens_to_theme`](./sfnext-match-tokens-to-theme) - Match design tokens to theme variables
84
86
- Part of the [STOREFRONTNEXT](../toolsets#storefrontnext) toolset
0 commit comments