Salesforce MCP Server

Salesforce MCP Server

一个将 Claude 与 Salesforce 集成的 MCP（Model Context Protocol）服务实现，让你能够通过自然语言与 Salesforce 数据和元数据交互。此服务支持 Claude 使用日常语言查询、修改和管理 Salesforce 对象与记录。

功能

• 对象和字段管理：使用自然语言创建和修改自定义对象及字段
• 智能对象搜索：通过部分名称匹配查找 Salesforce 对象
• 详细架构信息：获取任意对象的完整字段和关系详情
• 灵活的数据查询：支持关系和复杂筛选条件的记录查询
• 数据操作：轻松插入、更新、删除和更新插入记录
• 跨对象搜索：使用 SOSL 跨多个对象搜索
• 直观的错误处理：提供清晰的反馈以及 Salesforce 专属错误详情

安装

npm install -g @surajadsul02/mcp-server-salesforce

设置

Salesforce 身份验证

你可以通过以下两种方式之一进行 Salesforce 身份验证：

1. 用户名/密码身份验证

1. 设置 Salesforce 凭据
2. 获取安全令牌（在 Salesforce 设置中重置）
3. 按照配置部分中的说明设置环境变量

2. 使用 Consumer Key/Secret 进行 OAuth2 身份验证

1. 在 Salesforce 中设置 Connected App
2. 获取 Consumer Key 和 Consumer Secret
3. 按照配置部分中的说明设置环境变量

IDE 集成

Cursor IDE 设置

1. 全局安装软件包：

npm install -g @surajadsul02/mcp-server-salesforce

2. 在 Cursor IDE 的 .cursor/mcp.json 中配置 MCP 服务：

使用 env 命令

{
  "mcpServers": {
    "salesforce": {
      "command": "env",
      "args": [
        "[email protected]",
        "SALESFORCE_PASSWORD=YourActualPassword123",
        "SALESFORCE_TOKEN=YourActualSecurityToken123",
        "SALESFORCE_INSTANCE_URL=https://login.salesforce.com",
        "npx",
        "-y",
        "@surajadsul02/mcp-server-salesforce"
      ]
    }
  }
}

在 Cursor 中进行 OAuth2 身份验证

{
  "mcpServers": {
    "salesforce": {
      "command": "env",
      "args": [
        "[email protected]",
        "SALESFORCE_PASSWORD=YourActualPassword123",
        "SALESFORCE_TOKEN=YourActualSecurityToken123",
        "SALESFORCE_INSTANCE_URL=https://login.salesforce.com",
        "SALESFORCE_CONSUMER_KEY=YourConsumerKey",
        "SALESFORCE_CONSUMER_SECRET=YourConsumerSecret",
        "npx",
        "-y",
        "@surajadsul02/mcp-server-salesforce"
      ]
    }
  }
}

Claude Desktop 设置

1. 全局安装软件包（如果尚未安装）：

npm install -g @surajadsul02/mcp-server-salesforce

2. 添加到 claude_desktop_config.json：

使用用户名/密码身份验证

{
  "mcpServers": {
    "salesforce": {
      "command": "npx",
      "args": ["-y", "@surajadsul02/mcp-server-salesforce"],
      "env": {
        "SALESFORCE_USERNAME": "your_username",
        "SALESFORCE_PASSWORD": "your_password",
        "SALESFORCE_TOKEN": "your_security_token",
        "SALESFORCE_INSTANCE_URL": "https://login.salesforce.com"
      }
    }
  }
}

使用 OAuth2 身份验证

{
  "mcpServers": {
    "salesforce": {
      "command": "npx",
      "args": ["-y", "@surajadsul02/mcp-server-salesforce"],
      "env": {
        "SALESFORCE_USERNAME": "your_username",
        "SALESFORCE_PASSWORD": "your_password",
        "SALESFORCE_CONSUMER_KEY": "your_consumer_key",
        "SALESFORCE_CONSUMER_SECRET": "your_consumer_secret",
        "SALESFORCE_INSTANCE_URL": "https://login.salesforce.com"
      }
    }
  }
}

3. 配置文件位置：
   • macOS：~/Library/Application Support/Claude Desktop/claude_desktop_config.json
   • Windows：%APPDATA%\Claude Desktop\claude_desktop_config.json
   • Linux：~/.config/Claude Desktop/claude_desktop_config.json

必需的环境变量

用户名/密码身份验证：

• SALESFORCE_USERNAME：你的 Salesforce 用户名/电子邮件
• SALESFORCE_PASSWORD：你的 Salesforce 密码
• SALESFORCE_TOKEN：你的 Salesforce 安全令牌
• SALESFORCE_INSTANCE_URL：你的 Salesforce 实例 URL（可选，默认值：https://login.salesforce.com）

OAuth2 身份验证：

• SALESFORCE_USERNAME：你的 Salesforce 用户名/电子邮件
• SALESFORCE_PASSWORD：你的 Salesforce 密码
• SALESFORCE_CONSUMER_KEY：Connected App 的 Consumer Key
• SALESFORCE_CONSUMER_SECRET：Connected App 的 Consumer Secret
• SALESFORCE_INSTANCE_URL：你的 Salesforce 实例 URL（可选，默认值：https://login.salesforce.com）

使用示例

搜索对象

"Find all objects related to Accounts"
"Show me objects that handle customer service"
"What objects are available for order management?"

获取架构信息

"What fields are available in the Account object?"
"Show me the picklist values for Case Status"
"Describe the relationship fields in Opportunity"

查询记录

"Get all Accounts created this month"
"Show me high-priority Cases with their related Contacts"
"Find all Opportunities over $100k"

管理自定义对象

"Create a Customer Feedback object"
"Add a Rating field to the Feedback object"
"Update sharing settings for the Service Request object"

跨对象搜索

"Search for 'cloud' in Accounts and Opportunities"
"Find mentions of 'network issue' in Cases and Knowledge Articles"
"Search for customer name across all relevant objects"

开发

从源代码构建

# Clone the repository
git clone https://github.com/surajadsul02/mcp-server-salesforce.git

# Navigate to directory
cd mcp-server-salesforce

# Install dependencies
npm install

# Build the project
npm run build

故障排查

1. 身份验证错误

   • 确认凭据正确
   • 对于用户名/密码身份验证：确保安全令牌正确
   • 对于 OAuth2：确认使用者密钥和密钥正确

2. 连接问题

   • 检查 Salesforce 实例 URL
   • 确认网络连接正常
   • 确保具有适当的 API 访问权限

3. Cursor IDE 集成

   • 配置更改后重启 Cursor IDE
   • 在开发者工具（Help > Toggle Developer Tools）中查看错误消息
   • 确认已全局安装该软件包

4. Claude Desktop 集成

   • 确认配置文件的位置
   • 检查文件权限
   • 配置更改后重启 Claude Desktop
   • 确保已正确设置环境变量

贡献

欢迎贡献！欢迎提交 Pull Request。

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

问题与支持

如果您遇到任何问题或需要支持，请在 GitHub 仓库中提交问题。