Salesforce DX Developer Guide
jNewer Version Available
Install and Configure the Salesforce DX MCP Server (Beta)
Follow these steps:
Add the Salesforce DX MCP Server to Your MCP Client (Beta)
While each MCP client has different JSON files, the format of the args option is always the same.
Agentforce Vibes
The Salesforce DX MCP Server is pre-configured in Agentforce Vibes. See Agentforce Vibes Extension Includes the Salesforce DX MCP Server.
VS Code with Copilot
See the Quick Start Using the VS Code With Copilot MCP Client (Beta), which uses VS Code with GitHub Copilot as the example. The topic includes details about which JSON file to update and an example JSON snippet.
Other MCP Clients
To configure the Salesforce DX MCP Server in other MCP clients, such as Claude Code and Cursor, see the README for the Salesforce DX MCP Server GitHub repository.
Configure the Salesforce DX MCP Server for Your Environment (Beta)
Surround the flag name and its value each in double quotes, and separate all flags and values with commas. Boolean flags don't take a value.
Let’s just run through some examples so you get the idea. Then see later sections for the full list of values you can specify for the args option and its flags.
This basic example (for the VS Code with Copilot MCP client) configures the DX MCP Server to access your default org and enables the core DX toolsets.
1{
2 "servers": {
3 "Salesforce DX": {
4 "command": "npx",
5 "args": ["-y", "@salesforce/mcp@latest",
6 "--orgs", "DEFAULT_TARGET_ORG",
7 "--toolsets", "orgs,metadata,data,users,testing"]
8 }
9 }
10}The "-y", "@salesforce/mcp@latest" part tells the npx command to automatically install the latest version of the @salesforce/mcp npm package instead of asking permission. Don't change this.
From now on we’ll show examples of just the args option, which is the key configuration option for the Salesforce DX MCP Server.
This example shows how to enable just the data, orgs, and metadata toolsets and allow access to two orgs: your default Dev Hub org and an org with username test-org@example.com.
1"args": ["-y", "@salesforce/mcp@latest",
2 "--orgs", "DEFAULT_TARGET_DEV_HUB,test-org@example.com",
3 "--toolsets", "data,orgs,metadata"]This example shows how to configure access to two orgs for which you specified aliases when you authorized them (my-scratch-org and my-dev-hub).
1"args": ["-y", "@salesforce/mcp@latest",
2 "--orgs", "my-scratch-org,my-dev-hub",
3 "--toolsets", "data,orgs,metadata"]This example allows the MCP Server to access all your authorized orgs, all toolsets, and tools that are not yet generally available. In other words, this enables everything! Only do this if you truly need everything.
1"args": ["-y", "@salesforce/mcp@latest",
2 "--orgs", "ALLOW_ALL_ORGS",
3 "--toolsets", "all",
4 "--allow-non-ga-tools"]This example enables five tool sets (data, orgs, metadata, lwc-experts, and code-analysis) and a specific tool (run_apex_test) from a different toolset.
1"args": ["-y", "@salesforce/mcp@latest",
2 "--orgs", "DEFAULT_TARGET_ORG",
3 "--toolsets", "data,orgs,metadata,lwc-experts,code-analysis",
4 "--tools", "run_apex_test",
5 "--allow-non-ga-tools"]This example allows access to both your default org and default Dev Hub org. It also enables three specific MCP tools rather than using toolsets. The core toolset is always enabled, even if you don't specify it in the server configuration.
1"args": ["-y", "@salesforce/mcp@latest",
2 "--orgs", "DEFAULT_TARGET_ORG,DEFAULT_TARGET_DEV_HUB",
3 "--tools", "list_all_orgs,deploy_metadata,run_apex_test"]This example enables the orgs toolset and the specific tool deploy_metadata.
1"args": ["-y", "@salesforce/mcp@latest",
2 "--orgs", "DEFAULT_TARGET_ORG",
3 "--toolsets", "orgs",
4 "--tools", "deploy_metadata"]Valid Values for the args Option
These are the flags that you can pass to the args option.
| Flag Name | Required? | Description |
|---|---|---|
| --orgs | Yes | One or more orgs that you've locally authorized and are allowing the MCP Server to use.
You must specify at least one org. |
| --toolsets | You must specify at least one of these flags: --toolsets, --tools, --dynamic-tools. | Groups of MCP tools based on functionality. Allows you to run the DX MCP Server with only the tools you require, which in turn reduces the LLM context. |
| --tools | You must specify at least one of these flags: --toolsets, --tools, --dynamic-tools. | Specific MCP tools you want to enable. |
| --no-telemetry | No | Boolean flag to disable telemetry, which is the automatic collection of data for
monitoring and analysis. Telemetry is enabled by default, so specify this flag to disable it. |
| --debug | No | Boolean flag that requests that the DX MCP Server print debug logs. Debug mode is disabled by default. Not all MCP clients expose MCP logs, so this flag might not work in your environment. |
| --allow-non-ga-tools | No | Boolean flag to allow the DX MCP Server to use both the generally available (GA) and
NON-GA tools that are in the toolset you specify.
By default, the DX MCP Server uses only the tools marked GA. |
| --dynamic-tools | You must specify at least one of these flags: --toolsets, --tools, --dynamic-tools. | (experimental) Boolean flag that enables dynamic tool discovery and loading. When
specified, the DX MCP Server starts with a minimal
set of core tools and loads new tools as needed.
This flag is useful for reducing the initial context size and improving LLM performance. Dynamic tool discovery is disabled by default. This feature works in VS Code and Cline but may not work in other MCP clients. |
Valid Values for the --orgs Flag
The Salesforce MCP tools require an org, and so you must include the required --orgs flag and specify at least one authorized org. Separate multiple values with commas.
We recommend that, for security reasons, you don’t automatically specify all the orgs you’ve authorized but instead only the orgs you want the DX MCP Server to access.
You must explicitly authorize the orgs on your computer before the MCP server can access them. Use the org login web Salesforce CLI command or the VS Code SFDX: Authorize an Org command from the command palette.
These are the available values for the --orgs flag.
| Flag Value | Description |
|---|---|
| DEFAULT_TARGET_ORG | Allow access to your default org. If you've set a local default org in your DX project, the DX MCP Server uses it. If not, the server uses a globally-set default org. |
| DEFAULT_TARGET_DEV_HUB | Allow access to your default Dev Hub org.
If you've set a local default Dev Hub org in your DX project, the DX MCP Server uses it. If not, the server uses a globally-set default Dev Hub org. |
| ALLOW_ALL_ORGS | Allow access to all authorized orgs. Use caution with this value! |
| <username or alias> | Allow access to a specific org by specifying its username or alias, such as my-org (alias) or test@example.com (username). |
Valid Values for the --toolsets Flag
The Salesforce DX MCP Server uses toolsets to logically group MCP tools based on functionality; use the --toolsets flag to specify the ones you want to enable for your environment. Separate multiple toolsets commas.
These are the available toolsets. For some of these toolsets, the complete list of included tools is documented in separate documentation, as indicated.
| Toolset Name | Description |
|---|---|
| all | Enables all available tools from all
toolsets. We recommend that you configure only the toolsets you’re going to use, rather than all of them with this value. The DX MCP Server includes over 60 MCP tools, so enabling them all in your MCP client can overwhelm the LLM context. |
| aura-experts | Tools to help you migrate Aura applications
to LWC. See the LWC MCP Tools documentation. |
| code-analysis | Tools to run a static analysis of your code using Salesforce Code Analyzer. |
| core | Core set of DX MCP tools. This toolset is
always enabled. See Core DX MCP Tools Reference for the included tools. |
| data | Tools to manage the data in your org, such
as listing all accounts. See Core DX MCP Tools Reference for the included tools. |
| devops | Tools to manage work items, resolve merge
conflicts, and troubleshoot deployment problems
within DevOps Center. See the DevOps MCP Tools documentation. |
| enrichment | Tools to enrich metadata components in your DX project. |
| experts-validation | Tools that validate and score LWC
components for production readiness. See the LWC MCP Tools documentation. |
| lwc-experts | Tools to help you design, build, test, and
optimize LWC code. See the LWC MCP Tools documentation. |
| metadata | Tools to deploy and retrieve metadata
between your org and DX project. See Core DX MCP Tools Reference for the included tools. |
| mobile | All the tools to help LWC developers create
Lightning web components that integrate with
device-native features and adhere to Mobile
Offline design patterns. See the Mobile MCP Tools documentation. |
| mobile-core | Core (minimal) set of tools to help LWC
developers create Lightning web components that
integrate with device-native features and adhere
to Mobile Offline design patterns. See the Mobile MCP Tools documentation. |
| orgs | Tools to manage your authorized orgs.
See Core DX MCP Tools Reference for the included tools. |
| scale-products | Tools to analyze and improve Apex
performance. See the ApexGuru documentation. |
| testing | Tools to test Salesforce features, such as
Apex classes and Agentforce agents. See Core DX MCP Tools Reference for the included tools. |
| users | Tools to manage org users, such as
assigning a permission set. See Core DX MCP Tools Reference for the included tools. |
Valid Values for the --tools Flag
You can use the --tools flag to enable specific tools. Use the --toolsets and --tools flags in combination to enable, for example, all the tools in the orgs toolset and just one tool (run_apex_test) in the testing toolset. Separate multiple tools with commas.
The easiest way to find the name of a specific MCP tool is using your MCP client. For example, in VS Code with GitHub Copilot, click the Configure Tools button in the bottom-right of the chat window to see all the available tools, including the Salesforce DX ones.
The Salesforce DX MCP Server GitHub repository README also has a list of the available MCP tools.
You can also refer to the documentation for the different types of MCP tools:
Manage the Salesforce DX MCP Server (Beta)
But most clients allow you to:
- Stop and restart the server. If a new version of the DX MCP Server npm package (@salesforce/mcp) was released, then it’s automatically updated.
- Set the LLM models that the DX MCP Server can use.
Check your MCP client documentation for details.
MCP Server Updates and Feedback
Release notes are available at the issue-only Github repository for the Salesforce DX MCP server. In this GitHub repository, you can also report bugs and suggest feedback.
To report bugs, first check if someone else already reported the issue. If you don’t see your bug listed, open a new issue.
For feature requests and other related topics, first review the existing discussions before you open a new discussion.