Mcp Salesforce Example

What is Mcp Salesforce Example about?

Enables developers to connect a local Node.js server to a Salesforce org and perform actions such as sending emails and deploying Apex code through the Model Context Protocol (MCP) interface.

How to use Mcp Salesforce Example?

1. Install dependencies with npm install or yarn install.
2. Create ./utils/credentials.js that exports a getSalesforceCredentials() function returning login URL, username, client ID, and private key for JWT Bearer Flow authentication.
3. Adjust claude_desktop_config.json (or your own MCP config) to point to the correct credential paths.
4. Start the server using node server.js.

Key features of Mcp Salesforce Example

• Simple Node.js setup with minimal external dependencies.
• JWT Bearer Flow authentication for secure, password‑less login.
• Sample endpoints for sending Salesforce emails and deploying Apex code.
• Ready‑to‑use MCP configuration template (claude_desktop_config.json).

Use cases of Mcp Salesforce Example

• Automating routine Salesforce tasks (e.g., mass email campaigns) from a local script.
• Integrating custom CI/CD pipelines to deploy Apex metadata without manual UI interaction.
• Building proof‑of‑concept integrations that demonstrate how MCP can communicate with Salesforce services.

FAQ from the Mcp Salesforce Example

Q: Do I need a Salesforce Connected App? A: Yes, a Connected App with JWT authentication enabled is required.

Q: Which Node.js version is supported? A: Any recent LTS version (e.g., 18.x or 20.x) works.

Q: Can I run this on a cloud server? A: Absolutely—just ensure the credentials.js file is securely stored and the environment can reach your Salesforce org.

Q: How do I change the MCP configuration file? A: Edit claude_desktop_config.json to update paths, ports, or other MCP settings as needed.

Salesforce MCP Sample Integration

This project provides a basic example of integrating with Salesforce using the Model Context Protocol (MCP). It allows interaction with Salesforce features like sending emails and deploying Apex code through MCP tools.

Prerequisites

• Node.js and npm (or yarn) installed.
• A Salesforce org where you can create a Connected App.

Setup

1. Install Dependencies:

   npm install
   # or
   yarn install
   

2. Configure Salesforce Credentials:

   • You MUST create a credentials.js file inside a utils folder (./utils/credentials.js).
   • This file needs to export a function getSalesforceCredentials() which returns your Salesforce connection details necessary for JWT Bearer Flow authentication.
   • Important: Ensure you have a Connected App configured in Salesforce for JWT authentication, allowing the appropriate scopes and pre-authorizing the relevant user profile.

   utils/credentials.js Example:

   import fs from 'fs';
   import path from 'path';
   // You might load these from environment variables, a config file, etc.
   
   export function getSalesforceCredentials() {
       // --- IMPLEMENT YOUR LOGIC HERE to securely load credentials ---
       const loginUrl = "YOUR_SALESFORCE_LOGIN_URL"; // e.g., https://login.salesforce.com or https://yourdomain.my.salesforce.com
       const username = "YOUR_SALESFORCE_USERNAME";
       const clientId = "YOUR_CONNECTED_APP_CONSUMER_KEY";
       // Load your private key used to sign the JWT assertion
       // Ensure the key is formatted correctly, including BEGIN/END lines.
       const privateKey = fs.readFileSync(path.resolve(__dirname, 'path/to/your/server.key'), 'utf8'); 
       // Example: const privateKey = process.env.SF_PRIVATE_KEY;
   
       if (!loginUrl || !username || !clientId || !privateKey) {
            throw new Error("Missing required Salesforce credentials in utils/credentials.js");
       }
   
       return {
           loginUrl,
           username,
           clientId,
           privateKey
       };
   }
   

3. Configuration File:

   • The repository includes a sample claude_desktop_config.json file that can be used as a template for configuring your MCP server.
   • Update the paths and credentials in this file according to your environment setup.

Running the Server

node server.js

Demo

https://github.com/user-attachments/assets/08c8015a-bc57-4c5e-9f3d-4a9d9d310f4c

Video in higher quality.