MCP Salesforce Example

What is MCP Salesforce Example about?

A sample project that demonstrates how to connect a Node.js MCP server to a Salesforce org, enabling actions such as sending emails and deploying Apex code using the Model Context Protocol.

How to use MCP Salesforce Example?

1. Install dependencies – run npm install or yarn install.
2. Create credentials – add a utils/credentials.js file that exports getSalesforceCredentials() with login URL, username, Connected App client ID, and the private key for JWT Bearer Flow.
3. Configure MCP – edit the provided claude_desktop_config.json (or create your own) to point to the correct credential paths.
4. Start the server – execute node server.js.

Key features of MCP Salesforce Example

• JWT Bearer Flow authentication for secure, password‑less login.
• Ready‑to‑use functions for sending Salesforce emails.
• Simple Apex deployment workflow via MCP.
• Minimal setup with only Node.js and a utils/credentials.js file.

Use cases of MCP Salesforce Example

• Rapid prototyping of Salesforce‑backed services in a custom application.
• Demonstrating MCP‑based communication patterns for internal tooling.
• Testing Apex deployment pipelines without a full CI/CD system.
• Building lightweight email‑sending utilities that leverage Salesforce templates.

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 Salesforce environments are supported? A: Both production (login.salesforce.com) and sandbox (test.salesforce.com) URLs are supported.

Q: Can I use environment variables instead of a file for credentials? A: Absolutely – the getSalesforceCredentials function can be modified to read from process.env.

Q: Is there a Docker setup? A: The repository does not include Docker configuration; you can containerize the Node.js app yourself if needed.

Q: How do I add more MCP endpoints? A: Extend server.js with additional route handlers that call Salesforce APIs using the authenticated client.

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.