Salesforce MCP Server

7 forks

8 stars

Free

What is salesforce-mcp-server

The salesforce-mcp-server is a powerful server solution developed by Kablewy that enables seamless interaction with Salesforce through its REST API using the jsforce library. This server is built on the Model Context Protocol (MCP), which allows AI systems to securely connect with various data sources and tools. With this server, you can manage Salesforce data efficiently by executing queries, retrieving metadata, and performing CRUD (Create, Read, Update, Delete) operations.

How to Use salesforce-mcp-server

To get started with the salesforce-mcp-server, follow these simple steps:

Clone the Repository: Begin by cloning the salesforce-mcp-server repository to your local machine.
Environment Setup: Copy the .env.example file to .env and populate it with your Salesforce credentials. This is crucial for the server to authenticate and communicate securely with Salesforce.
Install Dependencies: Run npm install to install all necessary dependencies required for the server to function properly.
Build the Server: Use the command npm run build to compile the server application.
Start the Server: Finally, launch the server with npm start. Once running, the server is ready to handle requests and perform operations on your Salesforce data.

Using the server, you can execute a variety of commands, such as querying Salesforce data, describing object metadata, and managing records. These functionalities are exposed through JSON-based commands, making it easy to integrate and automate Salesforce operations.

Key Features of salesforce-mcp-server

The salesforce-mcp-server offers several key features that enhance your ability to interact with Salesforce:

SOQL Query Execution: Execute Salesforce Object Query Language (SOQL) queries to retrieve data from your Salesforce instance efficiently.
Object Metadata Retrieval: Access detailed metadata about Salesforce objects, which is useful for understanding the structure and available fields of your data.
Record Management: Seamlessly create, update, and delete Salesforce records using structured JSON commands. This makes data management straightforward and efficient.
Secure Authentication Handling: The server incorporates secure methods to manage authentication with Salesforce, ensuring your data and operations remain protected.
Real-Time Data Access: Gain immediate access to Salesforce data in real-time, enabling up-to-date insights and rapid decision-making.

To ensure security, remember to protect your .env file and implement Salesforce IP restrictions where possible. Regularly updating your security tokens is also recommended to maintain a high level of security.

Overall, the salesforce-mcp-server is a versatile tool that simplifies Salesforce data interactions, allowing users to leverage the full potential of their Salesforce environment with ease. Whether you are performing complex data queries or managing records, this server provides a robust and secure solution for your needs.

A Model Context Protocol server implementation for interacting with Salesforce through its REST API using jsforce.

Installing via

To install Salesforce Server for Claude Desktop automatically via :

npx -y @/cli install salesforce-mcp-server --client claude

Features

Execute SOQL queries
Retrieve object metadata
Create, update, and delete records
Secure authentication handling
Real-time data access

Setup

Clone the repository
Copy .env.example to .env and fill in your Salesforce credentials
Install dependencies: npm install
Build: npm run build
Start: npm start

Usage

The server exposes several functions:

query

Execute SOQL queries against your Salesforce instance:

 "name": "query",
 "parameters": {
 "query": "SELECT Id, Name FROM Account LIMIT 5"

describe-object

Get metadata about a Salesforce object:

 "name": "describe-object",
 "parameters": {
 "objectName": "Account"

create

Create a new record:

 "name": "create",
 "parameters": {
 "objectName": "Contact",
 "data": {
 "FirstName": "John",
 "LastName": "Doe",
 "Email": "john.doe@example.com"

update

Update an existing record:

 "name": "update",
 "parameters": {
 "objectName": "Contact",
 "data": {
 "Id": "003XXXXXXXXXXXXXXX",
 "Email": "new.email@example.com"

delete

Delete a record:

 "name": "delete",
 "parameters": {
 "objectName": "Contact",
 "id": "003XXXXXXXXXXXXXXX"

Security

Make sure to:

Keep your .env file secure and never commit it
Use IP restrictions in Salesforce when possible
Regularly rotate your security token
Consider implementing additional authentication for the MCP server

Contributing

Contributions are welcome! Please submit PRs with improvements.