MCP Salesforce Integration 🚀

Welcome to the MCP Salesforce Integration repository! This project provides a complete Model Context Protocol (MCP) server designed specifically for seamless integration with Salesforce and Claude Desktop. Our goal is to simplify the process of connecting Salesforce with your applications, enabling efficient data management and user authentication.

Table of Contents

1. Introduction
2. Features
3. Installation
4. Usage
5. Authentication
6. CRUD Operations
7. Supported Platforms
8. Contributing
9. License
10. Links

Introduction

The MCP Salesforce Integration repository serves as a bridge between Salesforce and applications that utilize the Model Context Protocol. This integration allows developers to access Salesforce data and perform operations efficiently. The server handles OAuth authentication, ensuring secure access to Salesforce objects.

Features

- OAuth Authentication: Securely authenticate users and applications.
- Universal CRUD Operations: Create, Read, Update, and Delete operations on any Salesforce object.
- Cross-Platform Support: Compatible with Linux and macOS environments.
- Easy Setup: Simple installation process for quick deployment.
- Well-Documented: Comprehensive documentation for developers.

Installation

To get started with the MCP Salesforce Integration, follow these steps:

1. Clone the Repository:

   git clone https://github.com/Tyler4good/mcp-salesforce.git

   cd mcp-salesforce

   

2. Install Dependencies:
Make sure you have Node.js installed. Then run:

   npm install

   

3. Configuration:
Set up your environment variables for Salesforce credentials. Create a .env file in the root directory and add your Salesforce credentials.

4. Start the Server:
Run the following command to start the server:

   npm start

   

Usage

Once the server is running, you can interact with it using RESTful API calls. Below are examples of how to perform various operations.

Authentication

To authenticate, make a POST request to the /auth endpoint with your credentials. The server will respond with an access token.

CRUD Operations

You can perform CRUD operations on Salesforce objects using the following endpoints:

- Create: POST to /objects/{objectName}
- Read: GET from /objects/{objectName}/{id}
- Update: PUT to /objects/{objectName}/{id}
- Delete: DELETE from /objects/{objectName}/{id}

Replace {objectName} with the name of the Salesforce object and {id} with the object's ID.

Authentication

The OAuth authentication process is straightforward. Here’s how to implement it:

1. Request Access Token:
Send a POST request to the /auth endpoint with your Salesforce credentials.

2. Receive Access Token:
The server will return an access token. Use this token in the Authorization header for subsequent requests.

CRUD Operations

The MCP Salesforce Integration supports universal CRUD operations on any Salesforce object. Below are examples of how to use these operations.

Create

To create a new record, send a POST request to the appropriate endpoint. For example:

curl -X POST \
  http://localhost:3000/objects/Account \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "New Account",
    "Industry": "Technology"
  }'

Read

To read a record, send a GET request:

curl -X GET \
  http://localhost:3000/objects/Account/{id} \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Update

To update a record, send a PUT request:

curl -X PUT \
  http://localhost:3000/objects/Account/{id} \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Updated Account",
    "Industry": "Finance"
  }'

Delete

To delete a record, send a DELETE request:

curl -X DELETE \
  http://localhost:3000/objects/Account/{id} \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Supported Platforms

The MCP Salesforce Integration is designed to work on the following platforms:

- Linux: The server runs smoothly on various Linux distributions.
- macOS: Compatible with macOS environments for seamless development.

Contributing

We welcome contributions to enhance the MCP Salesforce Integration. If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Open a pull request to the main repository.

Please ensure your code adheres to our coding standards and includes tests where applicable.

License

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

Links

For the latest releases and updates, visit the Releases section. Here, you can download the necessary files and execute them as needed.

You can also check the Releases section for any updates or new features.

Thank you for your interest in the MCP Salesforce Integration! We hope this tool simplifies your development process and enhances your applications.