Skip to content

Commit f883f91

Browse files
@W-20598954 MCP docs adjust menu order. integrate auth links
1 parent 7b5fa8f commit f883f91

File tree

10 files changed

+33
-42
lines changed

10 files changed

+33
-42
lines changed

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ export default defineConfig({
166166
nav: [
167167
{text: 'Guide', link: '/guide/'},
168168
{text: 'CLI Reference', link: '/cli/'},
169-
{text: 'API Reference', link: '/api/'},
170169
{text: 'MCP Server', link: '/mcp/'},
170+
{text: 'API Reference', link: '/api/'},
171171
{
172172
text: isReleaseBuild ? 'Latest Release' : 'dev',
173173
items: getVersionItems(),

docs/guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@ See [Installation](./installation) for more options.
3333
- [Configuration](./configuration) - Configure instances and credentials
3434
- [IDE Integration](./ide-integration) - Connect Prophet VS Code to B2C CLI configuration
3535
- [CLI Reference](/cli/) - Browse available commands
36-
- [API Reference](/api/) - Explore the SDK API
3736
- [MCP Server](/mcp/) - AI-assisted development with Model Context Protocol
37+
- [API Reference](/api/) - Explore the SDK API

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ hero:
1616
- theme: alt
1717
text: CLI Reference
1818
link: /cli/
19-
- theme: alt
20-
text: API Reference
21-
link: /api/
2219
- theme: alt
2320
text: MCP Server
2421
link: /mcp/
22+
- theme: alt
23+
text: API Reference
24+
link: /api/
2525

2626
features:
2727
- icon: "\U0001F680"

docs/mcp/configuration.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The server automatically loads this file when `--working-directory` points to yo
4646
| **PWAV3** | None (uses `--working-directory` only) |
4747
| **STOREFRONTNEXT** | None (uses `--working-directory` only) |
4848

49-
**Note:** For `scapi_custom_apis_status`, OAuth credentials must include the `sfcc.custom-apis` scope.
49+
**Note:** Some tools require specific scopes. See [Configuring Scopes](../guide/authentication#configuring-scopes) in the Authentication Setup guide and individual tool pages for scope requirements.
5050

5151
#### MRT Credentials (`~/.mobify`)
5252

@@ -231,6 +231,8 @@ Enable specific tools instead of entire toolsets:
231231

232232
## Credential Details
233233

234+
For authentication setup instructions, see the [Authentication Setup guide](../guide/authentication) which covers API client creation, WebDAV access, SCAPI authentication, and MRT API keys.
235+
234236
### B2C Credentials
235237

236238
#### Username/Password (WebDAV)
@@ -240,24 +242,31 @@ Enable specific tools instead of entire toolsets:
240242

241243
**Used by:** CARTRIDGES toolset
242244

245+
See the [Authentication Setup guide](../guide/authentication#webdav-access) for detailed WebDAV access configuration.
246+
243247
#### OAuth Client Credentials
244248

245249
- `client-id` - API client ID from Account Manager
246250
- `client-secret` - API client secret from Account Manager
247251

248-
**Used by:** SCAPI toolset (required for `scapi_custom_apis_status`)
252+
**Used by:** SCAPI toolset
249253

250-
**Required scopes:**
251-
- `sfcc.custom-apis` - For custom API endpoint status queries
254+
**Note:** Some tools require specific scopes. See [Configuring Scopes](../guide/authentication#configuring-scopes) in the Authentication Setup guide and individual tool pages for scope requirements.
255+
256+
See the [Authentication Setup guide](../guide/authentication#account-manager-api-client) for creating and configuring API clients, and [SCAPI Authentication](../guide/authentication#scapi-authentication) for SCAPI-specific setup.
252257

253258
### MRT Credentials
254259

255260
- `api-key` - MRT API key from your Managed Runtime project
261+
- `project` - MRT project slug (required)
262+
- `environment` - MRT environment: `staging` or `production` (required when deploying)
256263

257264
**Used by:** MRT toolset
258265

259266
**Configuration location:** `~/.mobify` file
260267

268+
See the [Authentication Setup guide](../guide/authentication#managed-runtime-api-key) for detailed MRT API key setup instructions.
269+
261270
## Telemetry Configuration
262271

263272
Telemetry is enabled by default. Configure it via environment variables:

docs/mcp/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ The server automatically detects your project type and loads configuration from
5959
- Toolset selection (auto-discovery vs manual)
6060
- Required credentials per toolset
6161

62+
For authentication setup instructions, see the [Authentication Setup guide](../guide/authentication) which covers API client creation, WebDAV access, SCAPI authentication, and MRT API keys.
63+
6264
### Available Toolsets
6365

6466
The server provides five toolsets with specialized tools for different development workflows:

docs/mcp/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ The server reads [`dw.json`](../guide/configuration#configuration-file) from you
176176
}
177177
```
178178

179-
See the [Configuration Guide](./configuration) for details on credential management.
179+
See the [Authentication Setup guide](../guide/authentication) for detailed instructions on setting up API clients, WebDAV access, and SCAPI authentication.
180180

181181
### 3. Scaffolding
182182

docs/mcp/tools/cartridge-deploy.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,10 @@ This tool is useful for deploying custom code cartridges for SFRA or other B2C C
2020

2121
## Authentication
2222

23-
Requires B2C Commerce instance credentials. Supports two authentication methods:
23+
Supports two authentication methods:
2424

25-
### Option 1: Basic Authentication (WebDAV)
26-
27-
- `hostname` - B2C instance hostname
28-
- `username` - Username for Basic auth
29-
- `password` - Password or [WebDAV access key](https://help.salesforce.com/s/articleView?id=cc.b2c_account_manager_sso_use_webdav_file_access.htm&type=5)
30-
31-
### Option 2: OAuth
32-
33-
- `hostname` - B2C instance hostname
34-
- `client-id` - OAuth client ID from Account Manager
35-
- `client-secret` - OAuth client secret from Account Manager
25+
- **Basic Authentication (WebDAV)** - See [B2C Credentials](../configuration#b2c-credentials) (Username/Password section)
26+
- **OAuth** - See [B2C Credentials](../configuration#b2c-credentials) (OAuth Client Credentials section)
3627

3728
**Configuration priority:**
3829
1. Flags (`--server`, `--username`, `--password`, `--client-id`, `--client-secret`)
@@ -106,5 +97,6 @@ Returns a deployment result object containing:
10697
## See Also
10798

10899
- [CARTRIDGES Toolset](../toolsets#cartridges) - Overview of cartridge development tools
100+
- [Authentication Setup](../../guide/authentication) - Set up WebDAV access and OAuth credentials
109101
- [Configuration](../configuration) - Configure credentials and instance settings
110102
- [CLI Reference](../../cli/code) - Equivalent CLI command: `b2c code deploy`

docs/mcp/tools/mrt-bundle-push.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,13 @@ This tool is shared across the MRT, PWAV3, and STOREFRONTNEXT toolsets.
2121

2222
## Authentication
2323

24-
Requires Managed Runtime (MRT) credentials:
25-
26-
- `api-key` - MRT API key (from `~/.mobify` or `SFCC_MRT_API_KEY`)
27-
- `project` - MRT project slug (required, via `--project` flag or `SFCC_MRT_PROJECT`)
28-
- `environment` - MRT environment: `staging` or `production` (optional, required when `deploy: true`)
24+
Requires Managed Runtime (MRT) credentials. See [MRT Credentials](../configuration#mrt-credentials) for complete details.
2925

3026
**Configuration priority:**
3127
1. Flags (`--api-key`, `--project`, `--environment`)
3228
2. Environment variables (`SFCC_MRT_API_KEY`, `SFCC_MRT_PROJECT`, `SFCC_MRT_ENVIRONMENT`)
3329
3. `~/.mobify` config file (or `~/.mobify--[hostname]` if `--cloud-origin` is set)
3430

35-
You can also configure MRT credentials using the [B2C CLI](../../cli/mrt#b2c-mrt-config-set):
36-
37-
```bash
38-
b2c mrt config set --api-key YOUR_API_KEY
39-
```
40-
4131
## Parameters
4232

4333
| Parameter | Type | Required | Default | Description |
@@ -117,5 +107,6 @@ The tool will throw an error if:
117107
## See Also
118108

119109
- [MRT Toolset](../toolsets#mrt) - Overview of Managed Runtime tools
110+
- [Authentication Setup](../../guide/authentication#managed-runtime-api-key) - Set up MRT API key
120111
- [Configuration](../configuration) - Configure MRT credentials
121112
- [CLI Reference](../../cli/mrt) - Equivalent CLI command: `b2c mrt bundle push`

docs/mcp/tools/scapi-custom-apis-status.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,9 @@ The `scapi_custom_apis_status` tool checks the registration status of custom API
1919

2020
## Authentication
2121

22-
Requires OAuth credentials with the `sfcc.custom-apis` scope:
22+
Requires OAuth credentials. See [B2C Credentials](../configuration#b2c-credentials) (OAuth Client Credentials section) for complete details.
2323

24-
- `hostname` - B2C instance hostname
25-
- `client-id` - OAuth client ID
26-
- `client-secret` - OAuth client secret
27-
- OAuth scope: `sfcc.custom-apis` (required)
24+
**Required scope:** `sfcc.custom-apis`
2825

2926
**Configuration priority:**
3027
1. Flags (`--server`, `--client-id`, `--client-secret`)
@@ -199,5 +196,6 @@ Check the `message` field for detailed error information.
199196

200197
- [SCAPI Toolset](../toolsets#scapi) - Overview of SCAPI discovery tools
201198
- [scapi_schemas_list](./scapi-schemas-list) - List and fetch SCAPI schemas
199+
- [Authentication Setup](../../guide/authentication#scapi-authentication) - Set up SCAPI authentication with required roles and scopes
202200
- [Configuration](../configuration) - Configure OAuth credentials
203201
- [CLI Reference](../../cli/custom-apis) - Equivalent CLI command: `b2c scapi custom status`

docs/mcp/tools/scapi-schemas-list.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ This tool works with both standard SCAPI (Shop, Admin, Shopper APIs) and custom
1717

1818
## Authentication
1919

20-
Requires OAuth credentials with the `sfcc.scapi-schemas` scope:
20+
Requires OAuth credentials. See [B2C Credentials](../configuration#b2c-credentials) (OAuth Client Credentials section) for complete details.
2121

22-
- `hostname` - B2C instance hostname
23-
- `client-id` - OAuth client ID
24-
- `client-secret` - OAuth client secret
22+
**Required scope:** `sfcc.scapi-schemas` (required for fetch mode)
2523

2624
**Note:** OAuth credentials are optional for local schema discovery (list mode), but required for fetching full schemas.
2725

@@ -166,5 +164,6 @@ Use the MCP tool to show me the full OpenAPI spec for shopper-products v1.
166164

167165
- [SCAPI Toolset](../toolsets#scapi) - Overview of SCAPI discovery tools
168166
- [scapi_custom_apis_status](./scapi-custom-apis-status) - Check custom API endpoint registration status
167+
- [Authentication Setup](../../guide/authentication#scapi-authentication) - Set up SCAPI authentication with required roles and scopes
169168
- [Configuration](../configuration) - Configure OAuth credentials
170169
- [CLI Reference](../../cli/scapi-schemas) - Equivalent CLI commands: `b2c scapi schemas list` and `b2c scapi schemas get`

0 commit comments

Comments
 (0)