Skip to content

@W-21420245 Update MCP docs#236

Merged
yhsieh1 merged 3 commits intomainfrom
t/commerce/W-21420245/update-mcp-docs
Mar 6, 2026
Merged

@W-21420245 Update MCP docs#236
yhsieh1 merged 3 commits intomainfrom
t/commerce/W-21420245/update-mcp-docs

Conversation

@yhsieh1
Copy link
Contributor

@yhsieh1 yhsieh1 commented Mar 6, 2026

Summary

Update MCP docs:

  • Better user experience: clearer installation and configuration instructions
  • Improved accuracy: documentation matches implementation exactly
  • Enhanced discoverability: consistent structure and proper linking
  • Reduced confusion: eliminated conflicting or duplicate information
  • Project-level adoption: promoted best practices for team collaboration

Testing

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)

**Claude Code:**
```bash
cd /path/to/your/project
claude mcp add --transport stdio b2c-dx -- npx -y @salesforce/b2c-dx-mcp --allow-non-ga-tools
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should default to project level for claude. Is that the default with the claude CLI?

Same for plugin install when we have it. That's what we document in the plugin docs: https://salesforcecommercecloud.github.io/b2c-developer-tooling/guide/agent-skills.html#install-plugins

And we really should take advantage of the tabbed code examples. In the above we give both project and user install options in a single block. Vitepress supports this so we should use it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Its default to local scope which similar to project scope but the configuration is ~/.claude.json. I will update it to project scope to match our recommendation also use tabs to include user scope.

1. Flags (`--api-key`, `--project`, `--environment`)
2. Environment variables (`MRT_API_KEY`, `MRT_PROJECT`, `MRT_ENVIRONMENT`)
1. Flags (`--api-key`, `--project`, `--environment`, `--cloud-origin`)
2. Environment variables (`MRT_API_KEY`, `MRT_PROJECT`, `MRT_ENVIRONMENT`, `MRT_CLOUD_ORIGIN`)
Copy link
Contributor

Choose a reason for hiding this comment

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

weird to remove MRT_CLOUD_ORIGIN from here but leave it below; whereas optional MRT_ENVIRONMENT is still in both?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

both MRT_CLOUD_ORIGIN and MRT_ENVIRONMENT are listed and both are optional.

}
}
```
**Cursor:** [Add to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=b2c-dx&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBzYWxlc2ZvcmNlL2IyYy1keC1tY3AiLCItLXByb2plY3QtZGlyZWN0b3J5IiwiJHt3b3Jrc3BhY2VGb2xkZXJ9IiwiLS1hbGxvdy1ub24tZ2EtdG9vbHMiXX0=)
Copy link
Contributor

Choose a reason for hiding this comment

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

is the setup of this magic string documented in our contributing guide? i assume we'll need to change it occasionally in the future.

}
}
```
Telemetry is enabled by default and collects anonymous usage data to help improve the developer experience. To disable it, set `SFCC_DISABLE_TELEMETRY=true` in your MCP client configuration's `env` object.
Copy link
Contributor

Choose a reason for hiding this comment

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

i think we should keep the explicit note about what we don't collect here. otherwise users will opt out because of fear we are collecting something sensitive?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point. I will put them back.


The MCP server collects anonymous usage telemetry to help improve the developer experience. Telemetry is enabled by default.

**Development mode**: Telemetry is automatically disabled when using `bin/dev.js`, so local development and testing won't pollute production data.
Copy link
Contributor

Choose a reason for hiding this comment

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

do we put this and the SFCC_APP_INSIGHTS_KEY note in the MCP contributing doc. maybe, maybe not?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated CONTRIBUTION.md with telemetry development.

@yhsieh1 yhsieh1 merged commit 113e81e into main Mar 6, 2026
4 checks passed
@yhsieh1 yhsieh1 deleted the t/commerce/W-21420245/update-mcp-docs branch March 6, 2026 19:48
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.

3 participants