Salesforce MCP

🚀 Salesforce MCP Server

Salesforce MCP Server is a tool that enables interaction with Salesforce data through Natural Language Processing (NLP). It offers the following capabilities:

• Intelligent Object Search: Find Salesforce objects related to specific topics.
• Schema Information Retrieval: Obtain fields, relationships, and constraints of Salesforce objects.
• Data Query: Execute SOQL queries to retrieve eligible data records.
• Field Type Filtering: Filter fields in Salesforce objects by data type.
• Picklist Value Retrieval: Extract all possible values of Salesforce picklist fields.
• Debug Log Management: Enable, disable, or retrieve debug logs for specific users.
• Validation Rule Viewing: Understand all validation rules on Salesforce objects.

🚀 Quick Start

✨ Features

Salesforce MCP Server allows users to interact with Salesforce data using NLP, supporting functions such as intelligent object search, schema information retrieval, data query, etc.

📦 Installation

Prerequisites

To use the Salesforce MCP Server, ensure the following conditions are met:

1. Install Python 3.6 or higher.
2. Install and configure Docker (for running in a containerized environment).
3. Obtain access to a Salesforce developer sandbox or production environment.
4. Be familiar with Salesforce APIs and SOQL query syntax.

Installation and Configuration

Using Docker

1. Download and install Docker: https://www.docker.com/get-started
2. Clone the project repository:

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

3. Navigate to the project directory:

   cd salesforce-mcp-server
   

4. Start the Docker container:

   docker-compose up --build
   

5. Access the MCP Server console, which is on port 5000 by default.

Configuring in VS Code

1. Open VS Code and install the following extensions:
   • Python
   • Docker
2. Add the project folder to the VS Code workspace.
3. Install dependencies:

   pip install -r requirements.txt
   

4. Start the server:

   python server.py
   

💻 Usage Examples

Basic Usage

# Search for objects related to Account
search_objects("Account")

# Display objects for customer service
search_objects("Customer Service")

# List objects available for order management
search_objects("Order Management")

# Get fields of the Account object
describe_object("Account")

# Show picklist values for Case status
describe_picklist_values("Case", "Status")

# View relationship fields of Opportunity
describe_relationship_fields("Opportunity")

# Retrieve all Account records created this month
query_records("Account", ["Id", "Name", "Industry"], 
              where="createdDate >= LAST_N_DAYS:30",
              limit=10)

# Display high - priority Cases and their related Contacts
query_records("Case", ["Id", "Subject", "Priority", "ContactId"],
              where="Priority = 'High'", 
              fields=["Account.Name"])

# List all picklist fields on the Lead object
get_fields_by_type("Lead", "Picklist")

# Get all lookup fields on the Opportunity object
get_fields_by_type("Opportunity", "Lookup")

# Find all required fields on the Account object
get_fields_by_type("Account", "Required")

# Enable debug logs for a specific user
manage_debug_logs(action="enable", user_id="user@example.com")

# Retrieve recent logs of the admin user
manage_debug_logs(action="retrieve", user_id="admin@company.com")

# Disable all logging for a specified user
manage_debug_logs(action="disable", user_id="developer@organization.com")

# Show all validation rules on the Opportunity object
get_validation_rules("Opportunity")

# Understand constraints of the Account object
get_validation_rules("Account")

# List all validation rules of a custom object
get_validation_rules("Custom_Object__c")

📚 Documentation

Development Guide

Project Structure

salesforce-mcp-server/
├── server.py                 # Main server file
├── config.py                # Configuration management module
├── routes/                  # Route definitions and handling functions
│   ├── objects.py          # Object - related routes
│   └── queries.py          # Query - related routes
└── utils/                  # Utility function library
    ├── decorators.py       # Request handling decorators
    ├── auth.py            # Authentication module
    └── db_connection.py   # Database connection pool management

Development Steps

1. Install Dependencies:

   pip install -r requirements.txt
   

2. Configure Environment Variables: Add the following to the .env file:

   SALESFORCE_USERNAME=your_username@example.com
   SALESFORCE_PASSWORD=your_password
   SALESFORCE_SECURITY_TOKEN=your_token
   

3. Start the Development Server:

   python server.py --mode debug
   

4. Write Custom Routes: Add new Python files in the routes/ directory, inheriting from the BaseRoute class.
5. Debug and Test: Use the VS Code debugging feature or run unit tests in the terminal:

   pytest tests/
   

🤝 Contribution Guide

Contributions from the community are welcome! Please follow these steps:

1. Fork the project repository.
2. Create a new branch: git checkout -b feature/your-feature-name
3. Commit changes: git add . && git commit -m 'Your commit message'
4. Push to the remote repository: git push origin feature/your-feature-name
5. Submit a Pull Request

📄 License

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

📞 Contact

If you have any questions, please contact us via:

• Email: support@salesforce.com
• GitHub Repository: https://github.com/your-username/salesforce-mcp-server