Salesforce MCP Server
A highly customizable Model Context Protocol (MCP) server for integrating Salesforce APIs with GenAI applications.
Features
-
Comprehensive Salesforce API Coverage:
- SOQL queries with automatic pagination support
- SOSL (Salesforce Object Search Language) searches
- Record CRUD operations (Create, Read, Update, Delete)
- Metadata API access for object descriptions
- Bulk API operations for large data volumes
- Apex code execution capabilities
- Reports API with filtering support
- Organization limits and API usage monitoring
-
Flexible Authentication:
- OAuth 2.0 Web Server Flow
- OAuth 2.0 JWT Bearer Flow
- Username-Password Flow
- Connected App support
-
Enterprise-Ready:
- Multi-org support
- Rate limiting and retry logic
- Comprehensive error handling
- Audit logging
- Field-level security respect
Installation
pip install salesforce-mcp-server
Or install from source:
git clone https://github.com/asklokesh/salesforce-mcp-server.git
cd salesforce-mcp-server
pip install -e .
Configuration
Create a .env file or set environment variables:
# Salesforce Credentials
SALESFORCE_USERNAME=your_username@company.com
SALESFORCE_PASSWORD=your_password
SALESFORCE_SECURITY_TOKEN=your_security_token
SALESFORCE_DOMAIN=login # or test, or your custom domain
# OR use OAuth
SALESFORCE_CLIENT_ID=your_connected_app_client_id
SALESFORCE_CLIENT_SECRET=your_connected_app_client_secret
SALESFORCE_REDIRECT_URI=http://localhost:8080/callback
# Optional Settings
SALESFORCE_API_VERSION=59.0
SALESFORCE_SANDBOX=false
SALESFORCE_MAX_RETRIES=3
SALESFORCE_TIMEOUT=30
Quick Start
Basic Usage
from salesforce_mcp import SalesforceMCPServer
# Initialize the server
server = SalesforceMCPServer()
# Start the server
server.start()
Claude Desktop Configuration
Add to your Claude Desktop config:
{
"mcpServers": {
"salesforce": {
"command": "python",
"args": ["-m", "salesforce_mcp.server"],
"env": {
"SALESFORCE_USERNAME": "your_username@company.com",
"SALESFORCE_PASSWORD": "your_password",
"SALESFORCE_SECURITY_TOKEN": "your_security_token"
}
}
}
}
Available Tools
1. Query Records
Execute SOQL queries to retrieve data:
{
"tool": "salesforce_query",
"arguments": {
"query": "SELECT Id, Name, Email FROM Contact WHERE LastModifiedDate = TODAY",
"include_deleted": false
}
}
2. Get Record
Retrieve a specific record by ID:
{
"tool": "salesforce_get_record",
"arguments": {
"object_type": "Account",
"record_id": "001XX000003DHPh",
"fields": ["Name", "Industry", "AnnualRevenue"]
}
}
3. Create Record
Create new records:
{
"tool": "salesforce_create_record",
"arguments": {
"object_type": "Contact",
"data": {
"FirstName": "John",
"LastName": "Doe",
"Email": "john.doe@example.com",
"AccountId": "001XX000003DHPh"
}
}
}
4. Update Record
Update existing records:
{
"tool": "salesforce_update_record",
"arguments": {
"object_type": "Contact",
"record_id": "003XX000004TMM2",
"data": {
"Title": "Senior Developer",
"Department": "Engineering"
}
}
}
5. Delete Record
Delete records:
{
"tool": "salesforce_delete_record",
"arguments": {
"object_type": "Contact",
"record_id": "003XX000004TMM2"
}
}
6. Describe Object
Get metadata about Salesforce objects:
{
"tool": "salesforce_describe_object",
"arguments": {
"object_type": "Account"
}
}
7. Bulk Operations
Handle large data volumes:
{
"tool": "salesforce_bulk_create",
"arguments": {
"object_type": "Contact",
"records": [
{"FirstName": "Jane", "LastName": "Smith", "Email": "jane@example.com"},
{"FirstName": "Bob", "LastName": "Johnson", "Email": "bob@example.com"}
],
"batch_size": 200
}
}
8. Execute Apex
Run Apex code:
{
"tool": "salesforce_execute_apex",
"arguments": {
"apex_body": "System.debug('Hello from Apex!');"
}
}
9. Search Records (SOSL)
Search across multiple objects:
{
"tool": "salesforce_search",
"arguments": {
"search_query": "FIND {John} IN NAME FIELDS RETURNING Contact(Id, Name, Email), Account(Id, Name)"
}
}
10. Query Pagination
Handle large query results:
{
"tool": "salesforce_query_more",
"arguments": {
"next_records_url": "/services/data/v59.0/query/01gxx000000002ABC-2000"
}
}
11. Organization Limits
Get API limits and usage:
{
"tool": "salesforce_limits",
"arguments": {}
}
12. Run Reports
Execute Salesforce reports:
{
"tool": "salesforce_run_report",
"arguments": {
"report_id": "00O1i000004Gzr0EAC",
"filters": {
"reportMetadata": {
"reportFilters": [
{
"column": "CREATED_DATE",
"operator": "greaterThan",
"value": "2023-01-01"
}
]
}
}
}
}
Advanced Configuration
Multi-Org Support
from salesforce_mcp import SalesforceMCPServer, OrgConfig
# Configure multiple orgs
orgs = {
"production": OrgConfig(
username="prod@company.com",
password="prod_password",
security_token="prod_token",
domain="login"
),
"sandbox": OrgConfig(
username="sandbox@company.com.sandbox",
password="sandbox_password",
security_token="sandbox_token",
domain="test"
)
}
server = SalesforceMCPServer(orgs=orgs, default_org="production")
Custom Authentication
from salesforce_mcp import SalesforceMCPServer, JWTAuth
# JWT Bearer Flow
jwt_auth = JWTAuth(
client_id="your_client_id",
username="your_username",
private_key_file="path/to/private_key.pem",
sandbox=False
)
server = SalesforceMCPServer(auth=jwt_auth)
Rate Limiting
from salesforce_mcp import SalesforceMCPServer, RateLimitConfig
rate_limit = RateLimitConfig(
requests_per_second=10,
burst_size=20,
wait_on_limit=True
)
server = SalesforceMCPServer(rate_limit=rate_limit)
Integration Examples
See the examples/ directory for complete integration examples:
basic_usage.py- Simple queries and CRUD operationsbulk_operations.py- Handling large data volumesgenai_integration.py- Integration with GenAI APIsmulti_org.py- Managing multiple Salesforce orgsoauth_flow.py- OAuth authentication setup
Error Handling
The server provides detailed error information:
try:
result = server.execute_tool("salesforce_query", {
"query": "SELECT InvalidField FROM Account"
})
except SalesforceError as e:
print(f"Salesforce error: {e.error_code} - {e.message}")
print(f"Fields available: {e.available_fields}")
Security Best Practices
- Never commit credentials - Use environment variables or secure vaults
- Use OAuth when possible - More secure than username/password
- Implement field-level security - Respect Salesforce permissions
- Enable audit logging - Track all API operations
- Use IP restrictions - Limit access to known IP ranges
Contributing
Contributions are welcome! Please read our contributing guidelines and submit pull requests.
License
MIT License - see LICENSE file for details
Metadata
Release files for iflow-mcp_lokimcpuniverse-salesforce-mcp-server 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0.tar.gz | 33.4 kB | Without provenance | Details for iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0-py3-none-any.whl |
Total release size: 51.6 kB
Release files / iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0.tar.gz
| Download URL | iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0.tar.gz |
|---|---|
| Size | 33.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
856884a7fd78b48449b23fe8eea9230bd289b8b9129059c42f447434031f04d1
|
|
BLAKE2b-256 checksum How to use checksums |
d3f66165d8952adf3db3b2eecd89735f8551920ad787a6316dce4db9068ab1bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0-py3-none-any.whl
| Download URL | iflow_mcp_lokimcpuniverse_salesforce_mcp_server-0.1.0-py3-none-any.whl |
|---|---|
| Size | 18.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a98335b0b869bf384dd36c4a531f6175b6a416e985dda5a0d53f7a8d89110ca3
|
|
BLAKE2b-256 checksum How to use checksums |
de1aab83885283a6c5846e42f38fc5042ca4ef317789f51ab0ca1c3ae51512d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for iflow-mcp_lokimcpuniverse-salesforce-mcp-server 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.