The Salesforce MCP Server allows interaction with Salesforce via its REST API using jsforce, enabling:
Execute SOQL queries to retrieve data from Salesforce
Run Tooling API queries to interact with Salesforce development tools
Retrieve metadata about Salesforce objects with detailed descriptions
Manage metadata components for specific types like CustomObject, Flow, ApexClass, etc.
Create, update, and delete records in Salesforce
Secure authentication handling for safe API interactions
Real-time data access for up-to-date information
Allows interaction with Salesforce through its REST API using jsforce, including executing SOQL queries, retrieving object metadata, and creating, updating, and deleting records in Salesforce.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@salesforce-mcp-servershow me the top 5 accounts by revenue"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Salesforce MCP Server
A Model Context Protocol server implementation for interacting with Salesforce through its REST API using jsforce.
Installing via Smithery
To install Salesforce Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install salesforce-mcp-server --client claudeFeatures
Execute SOQL queries
Retrieve object metadata
Create, update, and delete records
Secure authentication handling
Real-time data access
Related MCP server: Salesforce MCP Server
Setup
Clone the repository
Copy
.env.exampleto.envand fill in your Salesforce credentialsInstall dependencies:
npm installBuild:
npm run buildStart:
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"
}
}Running evals
The evals package loads an mcp client that then runs the index.ts file, so there is no need to rebuild between tests. You can load environment variables by prefixing the npx command. Full documentation can be found here.
OPENAI_API_KEY=your-key npx mcp-eval src/evals/evals.ts src/tools.tsSecurity
Make sure to:
Keep your
.envfile secure and never commit itUse 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.
Salesforce MCP Server
A Model Context Protocol server implementation for interacting with Salesforce through its REST API using jsforce.
Installing via Smithery
To install Salesforce Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install salesforce-mcp-server --client claudeFeatures
Execute SOQL queries
Retrieve object metadata
Create, update, and delete records
Secure authentication handling
Real-time data access
Setup
Clone the repository
Copy
.env.exampleto.envand fill in your Salesforce credentialsInstall dependencies:
npm installBuild:
npm run buildStart:
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
.envfile secure and never commit itUse 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.
License
MIT License
MIT License
Copyright (c) 2024 Kablewy,LLC
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.This server cannot be installed
Resources
Looking for Admin?
Admins can modify the Dockerfile, update the server description, and track usage metrics. If you are the server author, to access the admin panel.