Salesforce DX

MCP Server for interacting with Salesforce instances

typescript

305

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "salesforcecli-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@salesforce/mcp",
        "--orgs",
        "DEFAULT_TARGET_ORG",
        "--toolsets",
        "orgs,metadata,data,users",
        "--tools",
        "run_apex_test",
        "--allow-non-ga-tools"
      ]
    }
  }
}

The Salesforce DX MCP Server provides a dedicated Model Context Protocol interface to help large language models interact with Salesforce orgs. It enables you to securely read, manage, and operate Salesforce resources through an MCP client, tailoring tool access to your needs and reducing the model’s context size.

How to use

You use the MCP server by configuring an MCP client to connect to the Salesforce DX MCP Server, then enabling desired toolsets and tools for your workflow. Start with selecting the orgs you want to authorize, choose which toolsets to expose, and optionally limit the tools to specific items. Your MCP client will invoke the server through the configured command, and you will receive responses that guide your automation or prompts.

How to install

Prerequisites: you need Node.js installed on your machine. If you do not have Node.js, install it from the official source for your operating system.

Step 1: Install the MCP client package globally or locally as part of your project setup. Step 2: Ensure you have the required permissions to run commands from your shell or IDE. Step 3: Prepare your MCP client configuration file to point to the Salesforce DX MCP Server and specify the appropriate orgs, toolsets, and tools.

Configuration and usage notes

The DX MCP Server is configured via the MCP client’s configuration file. Below is a representative example you can adapt in your project to start the server for use with a modern editor or IDE.

{
  "servers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp",
               "--orgs", "DEFAULT_TARGET_ORG",
               "--toolsets", "orgs,metadata,data,users",
               "--tools", "run_apex_test",
               "--allow-non-ga-tools"]
    }
  }
}