Salesforce MCP Server

Implementation of the Salesforce MCP Server, enabling interaction with Salesforce data and metadata through natural language

Customer data platform Developer tools #Salesforce integration #Natural language interaction #Data management #AI assistant Local .TypeScript

rating : 2.5 points

downloads : 21

update time : 2025-04-28

What is the Salesforce MCP Server?

The Salesforce MCP Server is a tool based on the Model Context Protocol (MCP) that allows you to interact with Salesforce objects and records using natural language. Whether you need to query, create, or modify data, you can complete operations with simple statements.

How to use the Salesforce MCP Server?

First, ensure that the required dependency packages are installed and the environment variables are correctly configured. Then, start the server and connect to your Salesforce instance through a supported IDE (such as Cursor or Claude Desktop).

Applicable scenarios

Suitable for enterprise users who want to simplify the Salesforce management process, especially those who hope to quickly complete data queries, updates, and other operations through natural language.

Main features

Object and field managementCreate and modify custom objects and their fields using natural language.

Smart object searchFind relevant Salesforce objects by partial name matching.

Detailed Schema informationGet comprehensive field and relationship details of any object.

Flexible data queryQuery records using complex filtering conditions and support cross-object relationships.

Data manipulationInsert, update, delete, and push up records.

Cross-object searchUse SOSL to search for specific keywords across multiple objects.

Intuitive error handlingProvide clear and Salesforce-specific error feedback information.

Advantages and limitations

Advantages

Efficiently manage Salesforce data without programming.

Support natural language input, reducing the learning cost.

Provide powerful cross-object search capabilities.

Clear error prompts facilitate troubleshooting.

Limitations

May not fully support complex business logic.

Performance is affected by Salesforce API rate limits.

Some advanced features require higher permission settings.

How to use

Install dependencies

Globally install the Node.js modules required for the MCP Server.

Configure environment variables

Set the necessary authentication information such as username, password, and security token.

Start the server

Run the MCP Server and verify that it is working properly.

Usage examples

Case 1: Search for account objectsUsers can query account-related information by entering natural language.

Case 2: Cross-object searchSearch for specific keywords across multiple objects.

Case 3: Update sharing settingsAdjust the sharing policy of specific objects.

Frequently Asked Questions

How to solve the authentication failure problem?

What if the server fails to start?

Does it support OAuth2 authentication?

Related resources

Official documentation

Gain in-depth understanding of how the MCP Server works.

GitHub repository

View the source code and submit issues.

Tutorial video

Quick start guide.

🚀 Salesforce MCP Server

An implementation of the MCP (Model Context Protocol) server that integrates Claude with Salesforce, enabling you to interact naturally with your Salesforce data and metadata using everyday language. This server allows Claude to query, manage, and manipulate your Salesforce data using everyday language.

🚀 Quick Start

The Salesforce MCP Server integrates Claude with Salesforce, allowing natural interaction with Salesforce data and metadata using everyday language.

✨ Features

Search Objects: Find all objects related to an account.
Get Schema Information: Display available fields for a customer feedback object.
Query Records: Retrieve all accounts created this month.
Manage Custom Objects: Create a customer feedback object.
Cross-Object Search: Search for "cloud" in accounts and opportunities.

📦 Installation

Clone the repository:

git clone https://github.com/surajadsul02/mcp-server-salesforce.git

Navigate to the directory:
```
cd mcp-server-salesforce
```
Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```

📚 Documentation

Configuration Guide

Username and Password Authentication

SALESFORCE_USERNAME: Your Salesforce username or email.
SALESFORCE_PASSWORD: Your Salesforce password.
SALESFORCE_TOKEN: Your Salesforce security token.
SALESFORCE_INSTANCE_URL: Your Salesforce instance URL (optional, default is https://login.salesforce.com).

OAuth2 Authentication

SALESFORCE_USERNAME: Your Salesforce username or email.
SALESFORCE_PASSWORD: Your Salesforce password.
SALESFORCE_CONSUMER_KEY: The consumer key of your connected app.
SALESFORCE_CONSUMER_SECRET: The consumer secret of your connected app.
SALESFORCE_INSTANCE_URL: Your Salesforce instance URL (optional, default is https://login.salesforce.com).

💻 Usage Examples

Search Objects

"Find all objects related to an account."
"Show objects that handle customer service."
"What objects are available for order management?"

Get Schema Information

"What fields are available in the Account object?"
"Show the dropdown values for case status."
"Describe the relationship fields in opportunities."

Query Records

"Get all accounts created this month."
"Show all high-priority cases and their related contacts."
"Find all opportunities with an amount over $100,000."

Manage Custom Objects

"Create a customer feedback object."
"Add a rating field to the feedback object."
"Update the sharing settings for the service request object."

Cross-Object Search

"Search for 'cloud' in accounts and opportunities."
"Find 'network issues' mentioned in cases and knowledge articles."
"Search for the customer name in all relevant objects."

Development Instructions

Clone the repository:

git clone https://github.com/surajadsul02/mcp-server-salesforce.git

Navigate to the directory:
```
cd mcp-server-salesforce
```
Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```

Troubleshooting

Authentication Errors:
- Verify that your credentials are correct.
- For username and password authentication: Ensure the security token is correct.
- For OAuth2: Verify the consumer key and secret.
Connection Issues:
- Check the Salesforce instance URL.
- Ensure the network connection is normal.
- Ensure correct API access permissions.
Cursor IDE Integration:
- Restart Cursor IDE after configuration changes.
- Use developer tools to check error messages.
- Confirm that the package is installed globally.
Claude Desktop Integration:
- Verify the configuration file location.
- Check file permissions.
- Restart Claude Desktop after configuration changes.
- Ensure environment variables are set correctly.

🔧 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

❓ Issues and Support

If you encounter any issues or need support, please submit an Issue in the GitHub repository.

Search for Salesforce standard and custom objects based on the name pattern.

Parameters

searchPattern : string*

Description

Search pattern for finding objects (e.g., 'Account Coverage')

Execute a SOQL query on Salesforce data and format the results.

Parameters

--objectName : *

Description

Name of the Salesforce object to query.

Parameters

--fields : *

Description

Fields to include in the query, separated by commas.

Parameters

--whereClause : *

Description

Optional WHERE clause for filtering records.

Parameters

--orderBy : *

Description

Optional ORDER BY clause for sorting records.

Parameters

--limit : *

Description

Optional LIMIT clause for controlling the number of returned records.

Use the MCP tool to perform a SOSL search query in Salesforce.

Parameters

--searchTerm : *

Description

Search term for finding records.

Parameters

--searchIn : *

Description

Specify the search location. Default value is 'ALL'.

Parameters

--withClauses : *

Description

Specify additional clauses in the SOSL query, such as WITH METADATA or WITH SNIPPET.

Parameters

--updateable : boolean*

Description

Flag to include updatable records in the results.

Parameters

--viewable : boolean*

Description

Flag to include viewable records in the results.

Search for Salesforce standard and custom objects based on the name pattern.

Parameters

searchPattern : string*

Description

Search pattern for finding objects (e.g., 'Account Coverage')

Execute a SOQL query on Salesforce data and format the results.

Parameters

--objectName : *

Description

Name of the Salesforce object to query.

Parameters

--fields : *

Description

Fields to include in the query, separated by commas.

Parameters

--whereClause : *

Description

Optional WHERE clause for filtering records.

Parameters

--orderBy : *

Description

Optional ORDER BY clause for sorting records.

Parameters

--limit : *

Description

Optional LIMIT clause for controlling the number of returned records.

Use the MCP tool to perform a SOSL search query in Salesforce.

Parameters

--searchTerm : *

Description

Search term for finding records.

Parameters

--searchIn : *

Description

Specify the search location. Default value is 'ALL'.

Parameters

--withClauses : *

Description

Specify additional clauses in the SOSL query, such as WITH METADATA or WITH SNIPPET.

Parameters

--updateable : boolean*

Description

Flag to include updatable records in the results.

Parameters

--viewable : boolean*

Description

Flag to include viewable records in the results.

Search for Salesforce standard and custom objects based on the name pattern.

Parameters

searchPattern : string*

Description

Search pattern for finding objects (e.g., 'Account Coverage')

Execute a SOQL query on Salesforce data and format the results.

Parameters

--objectName : *

Description

Name of the Salesforce object to query.

Parameters

--fields : *

Description

Fields to include in the query, separated by commas.

Parameters

--whereClause : *

Description

Optional WHERE clause for filtering records.

Parameters

--orderBy : *

Description

Optional ORDER BY clause for sorting records.

Parameters

--limit : *

Description

Optional LIMIT clause for controlling the number of returned records.

Use the MCP tool to perform a SOSL search query in Salesforce.

Parameters

--searchTerm : *

Description

Search term for finding records.

Parameters

--searchIn : *

Description

Specify the search location. Default value is 'ALL'.

Parameters

--withClauses : *

Description

Specify additional clauses in the SOSL query, such as WITH METADATA or WITH SNIPPET.

Parameters

--updateable : boolean*

Description

Flag to include updatable records in the results.

Parameters

--viewable : boolean*

Description

Flag to include viewable records in the results.

Featured MCP Services

Duckduckgo MCP Server

Certified

The DuckDuckGo Search MCP Server provides web search and content scraping services for LLMs such as Claude.

Markdownify is a multi-functional file conversion service that supports converting multiple formats such as PDFs, images, audio, and web page content into Markdown format.

The GitLab MCP server is a project based on the Model Context Protocol that provides a comprehensive toolset for interacting with GitLab accounts, including code review, merge request management, CI/CD configuration, and other functions.

A Python-based MCP Server that provides advanced to-do list management and content organization functions through the Notion API, enabling seamless integration between AI models and Notion.

UnityMCP is a Unity editor plugin that implements the Model Context Protocol (MCP), providing seamless integration between Unity and AI assistants, including real - time state monitoring, remote command execution, and log functions.

569

5 points

Figma Context MCP

Framelink Figma MCP Server is a server that provides access to Figma design data for AI programming tools (such as Cursor). By simplifying the Figma API response, it helps AI more accurately achieve one - click conversion from design to code.

Context7 MCP is a service that provides real-time, version-specific documentation and code examples for AI programming assistants. It is directly integrated into prompts through the Model Context Protocol to solve the problem of LLMs using outdated information.

A Gmail automatic authentication MCP server designed for Claude Desktop, supporting Gmail management through natural language interaction, including complete functions such as sending emails, label management, and batch operations.

TypeScript

285

4.5 points

Zhiqi Future, Your AI Solution Think Tank

English 简体中文繁體中文にほんご