Skip to content

@W-20598954 MCP Vuepress docs#172

Merged
clavery merged 17 commits into
mainfrom
psullivan.W-20598954.mcpVueDocs
Feb 24, 2026
Merged

@W-20598954 MCP Vuepress docs#172
clavery merged 17 commits into
mainfrom
psullivan.W-20598954.mcpVueDocs

Conversation

@patricksullivansf
Copy link
Copy Markdown
Contributor

@patricksullivansf patricksullivansf commented Feb 19, 2026

Summary

Add MCP to Documentation site.

Screenshot 2026-02-20 at 9 08 42 AM Screenshot 2026-02-20 at 9 05 56 AM Screenshot 2026-02-20 at 9 06 21 AM Screenshot 2026-02-20 at 9 06 54 AM Screenshot 2026-02-20 at 9 07 33 AM

Testing

Pull PR and test doc site locally with pnpm run docs:dev

Dependencies

  • No net-new third-party dependencies were added
  • If net-new third-party dependencies were added, rationale/discussion is included and 3pl-approved is set by a maintainer

  • Tests pass (pnpm test)
  • Code is formatted (pnpm run format)

@clavery
Copy link
Copy Markdown
Collaborator

clavery commented Feb 19, 2026

MCP Server should come before API reference in the header (we can also remove the latter from the homepage, it doesn't need to take up that space).

When I talked to Yuming I was wondering if we should try to "merge" the MCP in with the guides docs because there is so much overlap and then have sidebar sections specific to the CLI and MCP. Although maybe the sidebar would grow too large at that point.

We should make sure we're referencing back to the Authentication guide for detailed setup guides in AM.

@patricksullivansf
Copy link
Copy Markdown
Contributor Author

patricksullivansf commented Feb 20, 2026

MCP Server should come before API reference in the header (we can also remove the latter from the homepage, it doesn't need to take up that space).

Done, but I left API ref in the header. Seems useful and isn't crowded on my browser. YMMV.

When I talked to Yuming I was wondering if we should try to "merge" the MCP in with the guides docs because there is so much overlap and then have sidebar sections specific to the CLI and MCP. Although maybe the sidebar would grow too large at that point.

I can see the draw, but I believe the use cases and setup steps are different enough that it might cause confusion. Happy to be wrong though...

Done. (sort of). the MCP is partially integrated into the Guide: it shares the same nav menu and quick start includes the MCP.

We should make sure we're referencing back to the Authentication guide for detailed setup guides in AM.

Done. Linked the various auth references back to the configuration, and from there to the Auth guide. Also removed as much redundancy as I thought reasonable to balance comprehension vs maintainability. I'm sure more could be done here.

@patricksullivansf patricksullivansf force-pushed the psullivan.W-20598954.mcpVueDocs branch from d201b54 to a0b4d31 Compare February 20, 2026 21:09
Comment thread docs/mcp/tools/cartridge-deploy.md Outdated
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `directory` | string | No | Current working directory | Path to directory to search for cartridges. The tool recursively searches for `.project` files to identify cartridges. |
| `cartridges` | string[] | No | All found cartridges | Array of cartridge names to include in the deployment. Use this to selectively deploy specific cartridges when you have multiple cartridges but only want to update some. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Should we add "If not specified, all cartridges found in the directory are deployed." to be more clear?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment thread docs/mcp/tools/cartridge-deploy.md Outdated

Returns a deployment result object containing:

- `cartridges` - Array of cartridge names that were deployed
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • cartridges - Array of cartridge mappings that were deployed (each with name, src, dest)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

Comment thread docs/mcp/tools/cartridge-deploy.md Outdated

- `cartridges` - Array of cartridge names that were deployed
- `codeVersion` - Code version name used for deployment
- `hostname` - Instance hostname where cartridges were deployed
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems hostname should be removed. Its not included in DeployResult

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch. fixed

Comment thread docs/mcp/tools/mrt-bundle-push.md Outdated
Returns a push result object containing:

- `bundleId` - Unique identifier for the pushed bundle
- `project` - MRT project slug
Copy link
Copy Markdown
Contributor

@yhsieh1 yhsieh1 Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we update it to match PushResult?

  • projectSlug - MRT project slug
  • target - Target environment (if deployed)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

But brings up an interesting aside. Across the b2c tooling repo I think I see inconsistent usage of target, targetSlug, environment, and environmentSlug, not to mention the use of "environment" for process environment variables. Maybe we should standardize on one name for this concept?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user facing terms of environment and project should always be used. The slug qualifier should be probably be dropped for ID. I'm ambivalent on whether we say ID or omit it. Consult what managed runtime itself uses in it's UI. Our "ui" (flags, etc) should use the same convention.

Internally, in the SDK, we still make use of the API conventions. Because those are still called project/target in the managed runtime API and will probably always. Logging is also safe to use these terms.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@clavery not exactly sure what the desired action here is. Currently the SDK returns targetSlug. If the user facing term is environment then maybe the SDK needs a consistent mapping utility to change the SDK names to user names? I could see the exact same code needed for CLI as MCP for PushResult, for example.

Comment thread docs/mcp/tools/cartridge-deploy.md Outdated

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `directory` | string | No | Current working directory | Path to directory to search for cartridges. The tool recursively searches for `.project` files to identify cartridges. |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we update the 'Current working directory' to something like:
Working directory from --working-directory flag or SFCC_WORKING_DIRECTORY env var (falls back to process.cwd())

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. done.

Comment thread docs/mcp/installation.md Outdated
Projects with multiple markers (e.g., cartridges + PWA Kit) get combined toolsets. For example:
- Cartridges + PWA Kit → CARTRIDGES, PWAV3, MRT, SCAPI

## Testing the MCP Server Locally
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder should we remove this testing locally section? I feel this doc is for the end user but not for contributors who should reference contributor.md or mcp readme.md for local setup.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved all the development setup and guideles to a new MCP focused md file in the source package.

@clavery
Copy link
Copy Markdown
Collaborator

clavery commented Feb 23, 2026

Lets get a changeset for the docs and the MCP and use this is as the starting point for MCP release changes

@patricksullivansf patricksullivansf force-pushed the psullivan.W-20598954.mcpVueDocs branch from c10c86e to 1d62eb6 Compare February 23, 2026 21:12
@patricksullivansf
Copy link
Copy Markdown
Contributor Author

Lets get a changeset for the docs and the MCP and use this is as the starting point for MCP release changes

Done as a minor bump to dx-docs only. Please review.

yhsieh1
yhsieh1 previously approved these changes Feb 23, 2026
@yhsieh1 yhsieh1 self-requested a review February 23, 2026 21:48
Comment thread docs/guide/index.md Outdated
@@ -1,12 +1,15 @@
---
description: Introduction to the B2C CLI and SDK for Salesforce Commerce Cloud B2C code deployment, site management, and sandbox operations.
description: Introduction to the B2C CLI, MCP Server, and SDK for Salesforce Commerce Cloud B2C code deployment, site management, and sandbox operations.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noticed, should 'Salesforce Commerce Cloud B2C' be changed to 'Salesforce B2C Commerce'? Same for https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/pull/172/changes#diff-a9f09e5fd39208124b216a0cac772b60ab660bf177b9ecd1ab87f18006cecdbcR7

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. I did search for Commerce B2C and fixed a few more places including package.json names. Please review and let me know if I need to revert any these.
cc: @knhage @clavery

Comment thread package.json
Comment on lines +3 to 4
"description": "Salesforce B2C Commerce Command Line Tools",
"version": "0.0.1-preview",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was trying to apply some consistency of attribute ordering across package.json and arbitrarily chose description then version, but happy to use ither order or revert the order change.

clavery
clavery previously approved these changes Feb 24, 2026
clavery
clavery previously approved these changes Feb 24, 2026
yhsieh1
yhsieh1 previously approved these changes Feb 24, 2026
Comment thread action.yml Outdated
default: 'true'
working-directory:
description: 'Working directory for the command'
project-directory:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

think i need to revert this? @clavery

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@patricksullivansf patricksullivansf enabled auto-merge (squash) February 24, 2026 21:14
@clavery clavery disabled auto-merge February 24, 2026 21:23
@clavery clavery merged commit f82eaaf into main Feb 24, 2026
5 checks passed
@clavery clavery deleted the psullivan.W-20598954.mcpVueDocs branch February 24, 2026 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants