home / mcp / salesforce mcp server

Salesforce MCP Server

MCP Server for interacting with Salesforce instances

Installation

Add the following to your MCP client configuration file.

Configuration

{
  "mcpServers": {
    "kodey-ai-salesforce-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@salesforce/mcp",
        "--orgs",
        "DEFAULT_TARGET_ORG",
        "--toolsets",
        "all"
      ]
    }
  }
}

You can use the Salesforce MCP Server to interact with your Salesforce orgs through an MCP client. This server enables you to run LLM-driven tools to read, manage, and operate Salesforce resources securely, with built-in security and granular org access controls.

How to use

After configuring a client to talk to the Salesforce MCP Server, you can perform common Salesforce DX tasks using natural language in your MCP-enabled chat. The server routes your request to the appropriate toolset and presents the results, helping you list authorized orgs, view org data, deploy or retrieve metadata, and run queries.

How to install

Prerequisites you need before installing and using the Salesforce MCP Server:

Install Node.js and npm (preferred) or ensure your runtime supports npm-based commands.
Install the Salesforce DX CLI and have a DX project you can connect to.
Install VS Code if you want to use the VS Code client with MCP.

Then set up the MCP client configuration as shown in the code snippet below. This config enables the MCP server to run locally via npx and to target your default org.

Example configuration for VS Code

{
  "servers": {
    "Salesforce DX": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG", "--toolsets", "all"]
    }
  }
}

Starting the MCP server in VS Code

1. Open VS Code and run the MCP: List Servers command. 2. Select Salesforce DX and choose Start Server. 3. Check the Output panel for status updates.

Using the chat to run tasks

Open the Chat: Open Chat (Agent) and switch to Agent mode in your Copilot chat window. Describe the task in natural language, and the MCP server will determine the right tool to run. Click Continue to execute and view results.

Stopping or reconfiguring the server

To stop, restart, or view the MCP server configuration, use the MCP: List Servers command, select Salesforce DX, and choose the desired action.

Installing via Smithery

npx -y @smithery/cli install @kodey-ai/salesforce-mcp-kodey

Configure the DX MCP Server

Configure the Salesforce DX MCP Server by passing flags to the args option in your MCP client. Surround each flag name and value with double quotes and separate with commas. For example, you can enable all tools and target your default org.

Configure Orgs

Specify which authorized orgs the MCP server can access with the --orgs flag. Values can include DEFAULT_TARGET_ORG, DEFAULT_TARGET_DEV_HUB, ALLOW_ALL_ORGS, or a specific username/alias. You must authorize these orgs locally before access.

Configure Toolsets and Tools

Toolsets group tools to control context size and capabilities. You can enable all toolsets or pick specific ones like data, orgs, metadata, and others. You can also enable individual tools in combination with toolsets to tailor the server’s capabilities to your needs.

Security and access control

The server avoids exposing secrets in plain text and accesses pre-existing (encrypted) auth files on your machine. Access is restricted to orgs you explicitly allowlist when starting the server.

Notes and caveats

This MCP server is provided as a developer preview. Features and commands may change. Some tools are labeled NON-GA and require a specific flag to enable.

Troubleshooting

If you encounter authentication issues, re-authorize your orgs using the Salesforce CLI commands or the VS Code SFDX commands. Check that the configured org aliases in your mcp.json align with your authorized orgs.

Other clients to use with the Salesforce DX MCP Server

You can configure additional MCP clients to communicate with the Salesforce DX MCP Server by following their respective configuration formats and pointing to the same MCP command and args.

Configuring other clients to use the Salesforce DX MCP Server

Cursor and Cline configurations mirror the same pattern: specify the MCP command as npx, and pass the appropriate orgs and toolsets in the args array. Other clients can follow their own documentation while using the same MCP endpoint configuration approach.

Installing via Smithery (alternative)

npx -y @smithery/cli install @kodey-ai/salesforce-mcp-minimal

Available tools

get_username

Determines the appropriate username or alias for Salesforce operations, handling both default orgs and Dev Hubs.

resume_tool_operation

Resumes a long-running operation that wasn’t completed by another tool.

list_all_orgs

Lists all configured Salesforce orgs, with optional connection status checking.

create_org_snapshot

(NON-GA) Create a scratch org snapshot.

create_scratch_org

(NON-GA) Create a scratch org.

delete_org

(NON-GA) Delete a locally-authorized Salesforce scratch org or sandbox.

org_open

(NON-GA) Open an org in a browser.

run_soql_query

Runs a SOQL query against a Salesforce org.

assign_permission_set

Assigns a permission set to the user or on behalf of another user.

deploy_metadata

Deploys metadata from your DX project to an org.

retrieve_metadata

Retrieves metadata from your org to your DX project.

run_agent_test

Executes agent tests in your org.

run_apex_test

Executes apex tests in your org.

create_mobile_lwc_app_review

Provides TypeScript API documentation for Salesforce LWC App Review Service, offering expert guidance for implementing app review features in Lightning Web Components.

create_mobile_lwc_ar_space_capture

Provides TypeScript API documentation for Salesforce LWC AR Space Capture, offering expert guidance for implementing AR space capture features in Lightning Web Components.

create_mobile_lwc_barcode_scanner

Provides TypeScript API documentation for Salesforce LWC Barcode Scanner, offering expert guidance for implementing barcode scanning features in Lightning Web Components.

create_mobile_lwc_biometrics

Provides TypeScript API documentation for Salesforce LWC Biometrics Service, offering expert guidance for implementing biometric authentication features in Lightning Web Components.

create_mobile_lwc_calendar

Provides TypeScript API documentation for Salesforce LWC Calendar Service, offering expert guidance for implementing calendar integration features in Lightning Web Components.

create_mobile_lwc_contacts

Provides TypeScript API documentation for Salesforce LWC Contacts Service, offering expert guidance for implementing contacts management features in Lightning Web Components.

create_mobile_lwc_document_scanner

Provides TypeScript API documentation for Salesforce LWC Document Scanner, offering expert guidance for implementing document scanning features in Lightning Web Components.

create_mobile_lwc_geofencing

Provides TypeScript API documentation for Salesforce LWC Geofencing Service, offering expert guidance for implementing geofencing features in Lightning Web Components.

create_mobile_lwc_location

Provides TypeScript API documentation for Salesforce LWC Location Service, offering expert guidance for implementing location services in Lightning Web Components.

create_mobile_lwc_nfc

Provides TypeScript API documentation for Salesforce LWC NFC Service, offering expert guidance for implementing NFC features in Lightning Web Components.

create_mobile_lwc_payments

Provides TypeScript API documentation for Salesforce LWC Payments Service, offering expert guidance for implementing payment processing features in Lightning Web Components.

get_mobile_lwc_offline_analysis

Analyzes Lightning Web Components for mobile-specific issues and provides detailed recommendations for mobile offline compatibility and performance improvements.

get_mobile_lwc_offline_guidance

Provides structured review instructions to detect and remediate mobile offline code violations in Lightning Web Components for Salesforce Mobile Apps.

create_aura_blueprint_draft

Creates a comprehensive PRD blueprint for Aura component migration with migration guidance to LWC.

enhance_aura_blueprint_draft

Enhances an existing draft PRD with expert Aura insights to improve migration planning.

transition_prd_to_lwc

Provides migration bridge guidance for creating LWC components from Aura specifications.

orchestrate_aura_migration

End-to-end Aura to LWC migration workflow guidance.

orchestrate_lwc_component_creation

Step-by-step component creation workflow guidance for LWC components.

orchestrate_lwc_component_optimization

Performance optimization guidance for LWC components.

orchestrate_lwc_component_testing

Comprehensive testing workflow and test generation guidance for LWC components.

orchestrate_lwc_slds2_uplift

Migration guidance for upgrading to SLDS2 design system.

explore_lds_uiapi

Explores and documents Lightning Design System UI API capabilities.

guide_lds_data_consistency

Data consistency patterns for LDS components.

guide_lds_development

LDS development guidelines and component integration.

guide_lds_referential_integrity

Referential integrity patterns for LDS data management.

verify_aura_migration_completeness

Aura to LWC migration completeness checklist and validation.

guide_figma_to_lwc_conversion

Converts Figma designs to LWC component specifications.

run_lwc_accessibility_jest_tests

Accessibility testing utilities and Jest integration for LWC components.

run_code_analyzer

Performs static analysis of your code for best practices and security checks (NON-GA).

describe_code_analyzer_rule

Gets the description of a Salesforce Code Analyzer rule (NON-GA).