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 claude

Features

• Execute SOQL queries
• Retrieve object metadata
• Create, update, and delete records
• Secure authentication handling
• Real-time data access

Setup

1. Clone the repository
2. Copy .env.example to .env and fill in your Salesforce credentials
3. Install dependencies: npm install
4. Build: npm run build
5. 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"
  }
}

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.ts

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.

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 claude

Features

• Execute SOQL queries
• Retrieve object metadata
• Create, update, and delete records
• Secure authentication handling
• Real-time data access

Setup

1. Clone the repository
2. Copy .env.example to .env and fill in your Salesforce credentials
3. Install dependencies: npm install
4. Build: npm run build
5. 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"
    }
  }
}

... View full README on GitHub