salesforce-mcp-server

by kablewy

Customer Data Platforms

TypeScript

security – no known vulnerabilities (report Issue)

license - not found

quality - confirmed to work

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

Prompts

Interactive templates invoked by user choice

Name	Description
No prompts

Resources

Contextual data attached and managed by the client

Name	Description
No resources

Tools

Functions exposed to the LLM to take actions

Name	Description
`query`	Execute a SOQL query on Salesforce
`tooling-query`	Execute a query against the Salesforce Tooling API
`describe-object`	Get detailed metadata about a Salesforce object
`metadata-retrieve`	Retrieve metadata components from Salesforce

Server Configuration

Describes the environment variables required to run the server.

Name	Required	Description	Default
`SF_PASSWORD`	Yes	Your Salesforce password	sf_password
`SF_USERNAME`	Yes	Your Salesforce username	sf_user
`SF_SECURITY_TOKEN`	Yes	Your Salesforce security token	sf_security_token

Need Help?View Source Code Report Issue

README.md

Salesforce MCP Server

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

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.

GitHub Badge

Glama performs regular codebase and documentation scans to:

Confirm that the MCP server is working as expected.
Confirm that there are no obvious security issues with dependencies of the server.
Extract server characteristics such as tools, resources, prompts, and required parameters.

Our directory badge helps users to quickly asses that the MCP server is safe, server capabilities, and instructions for installing the server.

Copy the following code to your README.md file:

<a href="https://glama.ai/mcp/servers/y9k3w9grtk">
  <img width="380" height="200" src="https://glama.ai/mcp/servers/y9k3w9grtk/badge" />
</a>