返回市场
销售力量

销售力量

作者:AiondaDotCom8 星标更新:2025-07-16

项目介绍

技术文档摘要

MCP Salesforce Server

CI

这是一个使用OAuth认证与Salesforce无缝集成的模型上下文协议(MCP)服务器。此服务器使像Claude这样的AI助手能够通过安全、通用的接口与任何Salesforce组织进行交互。

✨ 特性

  • 🎯 无缝认证 - 当需要认证时,Claude会自动检测并透明处理
  • 🚀 零手动设置 - 不需要运行终端命令或手动OAuth流程
  • 🔐 只有OAuth认证 - 安全的基于浏览器的设置,带有自动令牌刷新
  • 🌐 普遍的Salesforce集成 - 适用于任何Salesforce组织,包括自定义对象和字段
  • 🧠 智能安装学习 - 分析您的整个Salesforce设置以提供智能帮助
  • 🔍 动态模式发现 - 自动适应您的Salesforce配置
  • 🔒 安全令牌存储 - 基于文件的存储,具有严格的生产级安全性权限
  • 🏠 跨平台家目录存储 - 凭据和缓存存储在用户的家目录中
  • 📝 完整的CRUD操作 - 查询、创建、更新和删除任何Salesforce记录
  • 📊 模式检查 - 获取关于对象和字段的详细信息
  • 💡 上下文感知建议 - 提供智能字段和对象名称建议
  • 💾 综合备份系统 - 支持所有Salesforce文件系统的完整数据和文件备份
  • ⏰ 时间机器功能 - 数据恢复和历史分析的时间点数据恢复
  • 📁 多格式文件支持 - 备份ContentVersions、Attachments和Documents及其正确的元数据

🚀 快速开始

先决条件

  • Node.js 18+
  • macOS(用于安全凭据存储)
  • 已配置OAuth的Salesforce连接应用

安装选项

🎯 推荐:使用NPX(无需安装)

使用NPX运行MCP服务器,无需永久安装:

{
  "mcpServers": {
    "salesforce": {
      "command": "npx",
      "args": ["@aiondadotcom/mcp-salesforce"]
    }
  }
}

✅ 使用NPX的好处:

  • 🔄 始终最新:自动使用最新发布的版本
  • 💾 无磁盘空间占用:无需永久安装
  • 🛡️ 无冲突:没有全局包冲突
  • 轻松更新:只需重启即可自动获取最新版本
  • 📋 简单配置:复制粘贴即可使用的MCP配置

NPX命令行用法:

# 获取版本
npx -p @aiondadotcom/mcp-salesforce mcp-salesforce --version

# 获取帮助
npx -p @aiondadotcom/mcp-salesforce mcp-salesforce --help

# 运行OAuth设置
npx -p @aiondadotcom/mcp-salesforce mcp-salesforce setup

🔧 替代方案:开发设置

对于开发或定制化:

  1. 克隆并安装依赖项

    git clone https://github.com/AiondaDotCom/mcp-salesforce.git
    cd mcp-salesforce
    npm install
    
  2. 配置凭据:当提示时,使用salesforce_setup工具配置您的凭据

  3. 添加到Claude桌面,使用本地路径(参见下面的配置

🎯 开始使用

就这样!当您第一次使用任何Salesforce工具时,Claude将自动处理设置和认证。

✨ 交互式设置过程!

  • 使用salesforce_setup工具配置您的凭据
  • Claude会询问您的Salesforce连接应用详情
  • 凭据安全地存储在您的家目录中
  • 从Claude桌面直接进行无缝OAuth流程

🧠 智能学习系统

  • 使用salesforce_learn来分析您的整个Salesforce安装
  • Claude学习所有自定义对象、字段和关系
  • 根据您的特定设置提供智能建议
  • 对复杂Salesforce环境的上下文感知辅助

📦 NPM包状态

包已成功发布!

@aiondadotcom/mcp-salesforce现在已在NPM上上线并准备好使用。

使用已发布的包

所有用户现在都可以使用NPX:

# 测试已发布的包
npx -p @aiondadotcom/mcp-salesforce mcp-salesforce --version
npx -p @aiondadotcom/mcp-salesforce mcp-salesforce --help

# 运行OAuth设置
npx -p @aiondadotcom/mcp-salesforce mcp-salesforce setup

发布详情

  • 包名@aiondadotcom/mcp-salesforce
  • 版本1.0.7(最新)
  • 注册表:NPM公共注册表
  • 组织@aiondadotcom
  • 访问:公开

状态

  • ✅ 包已发布到NPM
  • ✅ 已验证NPX兼容性
  • ✅ 实现了二进制包装器
  • ✅ 设置命令功能正常
  • ✅ MCP配置就绪
  • 立即可用

🎉 所有NPX功能现在对全球最终用户都可用!

🔧 配置

Salesforce连接应用设置

  1. 在Salesforce设置中,创建一个新的连接应用:

    • 应用名称:MCP Salesforce集成
    • API名称:mcp_salesforce_integration
    • 联系电子邮件:您的电子邮件
    • 启用OAuth设置:✅ 是
    • 回调URLhttp://localhost:8080/callback(将自动生成)
    • 选择的OAuth范围
      • 通过API管理用户数据(api)
      • 在任何时候执行请求(refresh_token, offline_access)
  2. 保存后,复制消费者密钥消费者秘密

凭据配置

首次使用应用程序时,使用salesforce_setup工具配置您的凭据:

  1. 交互式设置:Claude将提示您输入Salesforce凭据
  2. 客户端ID:您的Salesforce连接应用消费者密钥
  3. 客户端秘密:您的Salesforce连接应用消费者秘密
  4. 实例URL:您的Salesforce组织URL(例如,https://mycompany.salesforce.com

该工具将验证您的输入,并将凭据安全地存储在~/.mcp-salesforce.json中,具有受限权限(600)。

📁 文件位置:

  • 凭据~/.mcp-salesforce.json(包含OAuth令牌和凭据)
  • 缓存~/.mcp-salesforce-cache/(包含学习到的Salesforce模式和上下文)
  • 跨平台:适用于Windows、macOS和Linux

示例交互:

Claude: 我需要先设置您的Salesforce凭据。请使用salesforce_setup工具输入您的凭据。

您:使用salesforce_setup工具,clientId: "3MVG9...",clientSecret: "1234567890...",instanceUrl: "https://mycompany.salesforce.com"

Claude: ✅ Salesforce凭据配置成功!现在您可以使用其他Salesforce工具了。

Claude桌面集成

🎯 NPX配置(推荐)

将以下内容添加到您的Claude桌面MCP配置(~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "salesforce": {
      "command": "npx",
      "args": ["@aiondadotcom/mcp-salesforce"]
    }
  }
}

🔧 开发/本地配置

对于开发或定制化安装:

{
  "mcpServers": {
    "salesforce": {
      "command": "node",
      "args": ["/path/to/mcp-salesforce/src/index.js"]
    }
  }
}

🌐 VS Code MCP配置

对于安装了MCP扩展的VS Code:

{
  "servers": {
    "salesforce": {
      "command": "npx",
      "args": ["@aiondadotcom/mcp-salesforce"]
    }
  }
}

📸 演示截图

这里是一个逐步演示MCP Salesforce服务器的实际案例,展示验证和更新公司地址信息的过程:

第一步:地址验证请求

地址验证 Claude检查Salesforce中的Aionda GmbH账户是否具有正确的地址,通过将其与公司网站上的当前地址进行比较

第二步:地址对比结果

地址分析 Claude识别出Salesforce地址过时,显示当前Salesforce数据与公司网站实际地址之间的详细对比

第三步:自动化地址更新

地址更新 Claude成功更新Salesforce账户的正确当前地址,显示哪些字段被更改

第四步:Salesforce确认

Salesforce确认 Salesforce中的更新账户记录显示纠正后的地址信息现在准确且是最新的

🛠️ 可用工具

salesforce_learn

🧠 学习您的整个Salesforce安装 - 一次性分析所有对象、字段和自定义内容,并将这些信息本地存储以提供智能帮助。

// 一次分析Salesforce安装
{}

// 强制完全重新分析
{
  "force_refresh": true,
  "detailed_relationships": true
}

为什么重要?

  • Claude学习您的自定义对象如“TimeTracking__c”、“Project__c”等。
  • 识别所有自定义字段及其数据类型
  • 根据您的特定配置提供智能建议
  • 运行一次,然后AI将永久受益

salesforce_installation_info

📊 您的学习Salesforce安装概述 - 显示可用的对象、自定义字段和自定义内容。

// 安装的完整概述
{}

// 关于特定对象的详细信息
{
  "object_name": "TimeTracking__c"
}

// 搜索特定字段
{
  "field_search": "email",
  "show_custom_only": true
}

salesforce_query

针对任何Salesforce对象执行SOQL查询。

// 示例:获取最近的联系人
{
  "query": "SELECT Id, FirstName, LastName, Email FROM Contact WHERE CreatedDate = THIS_MONTH ORDER BY CreatedDate DESC LIMIT 10"
}

🧠 智能学习集成:

  • 当安装尚未学习时自动警告
  • 建议可用的对象和字段
  • 帮助正确API名称

salesforce_create

在任何Salesforce对象中创建新记录。

// 示例:创建一个新联系人
{
  "sobject": "Contact",
  "data": {
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "john.doe@example.com",
    "Phone": "555-1234"
  }
}

🧠 智能上下文: 当安装已被学习时,自动显示所选对象所需的字段。

salesforce_update

更新现有记录。

// 示例:更新联系人的电子邮件
{
  "sobject": "Contact",
  "id": "003XX000008b6cYAQ",
  "data": {
    "Email": "new.email@example.com",
    "Phone": "555-5678"
  }
}

🧠 智能上下文: 考虑来自学习安装的字段权限和数据类型。

salesforce_delete

删除记录(⚠️ 永久操作)。

// 示例:删除记录
{
  "sobject": "Contact",
  "id": "003XX000008b6cYAQ"
}

salesforce_describe

获取对象和字段的模式信息。

// 示例:获取Contact对象模式
{
  "sobject": "Contact"
}

// 或获取所有可用对象列表
{} // 空参数

salesforce_backup

💾 Salesforce的综合备份系统 - 创建所有数据和文件的完整备份,附带详细的恢复信息。

// 创建完整备份
{}

// 自特定日期以来的增量备份
{
  "backup_type": "incremental",
  "since_date": "2025-01-01T00:00:00Z"
}

// 具有特定选项的备份
{
  "options": {
    "include_files": true,
    "include_attachments": true,
    "include_documents": true,
    "parallel_downloads": 10
  }
}

备份的内容:

  • 📊 所有对象数据 - 所有可查询的对象,每个对象最多20个字段
  • 📁 现代文件 - 包含完整元数据的ContentVersions
  • 📎 旧版附件 - 具有正确文件扩展名的经典附件
  • 📄 文档 - 来自旧版系统的基于文件夹的文档
  • 🏗️ 模式信息 - 完整的对象结构和关系
  • 📋 备份清单 - 详细统计和恢复信息

备份结构:

salesforce-backup-2025-06-04T16-16-35-660Z/
├── metadata/           # 模式和对象定义
├── data/              # 所有对象的JSON数据
├── files/
│   ├── content-versions/  # 现代文件
│   ├── attachments/       # 旧版附件
│   └── documents/         # 旧版文档
└── backup-manifest.json   # 备份概览

salesforce_backup_list

📋 显示可用备份 - 所有本地备份的概览,附带统计数据和元数据。

// 列出所有可用备份
{}

// 关于特定备份的详细信息
{
  "backup_name": "salesforce-backup-2025-06-04T16-16-35-660Z"
}

salesforce_time_machine

⏰ 通过Salesforce数据的时间旅行 - 分析不同备份时间点的数据变化,并启用有针对性的恢复。

// 将当前状态与备份进行比较
{
  "backup_timestamp": "2025-06-04T16:16:35.660Z",
  "object_name": "Account"
}

// 显示自特定备份以来的所有更改
{
  "backup_timestamp": "2025-06-04T16:16:35.660Z",
  "show_all_changes": true
}

// 特定记录的详细分析
{
  "backup_timestamp": "2025-06-04T16:16:35.660Z",
  "object_name": "Contact",
  "record_id": "003XX000008b6cYAQ"
}

时间机器功能:

  • 📊 数据比较 - 显示备份与当前状态之间的差异
  • 🔍 更改历史 - 哪些字段何时更改
  • 🗑️ 删除的记录 - 查找自备份以来被删除的记录
  • 📈 成长分析 - 数据发展的统计评估
  • 🎯 目标恢复 - 精确识别更改

salesforce_auth

与Salesforce进行身份验证。自动检测是否需要身份验证并处理OAuth流程。

// 示例:标准身份验证(检测是否需要)
{}

// 示例:即使令牌看似有效也强制重新身份验证
{
  "force": true
}

✨ 主要特点:

  • 自动检测:当需要身份验证时,Claude会自动建议使用此工具
  • 无需手动设置:消除手动运行npm run setup的需求
  • 智能身份验证:仅在必要时进行身份验证,首先检查现有令牌
  • 无缝集成:在后台透明工作

当以下情况发生时,此工具会被自动建议

  • 您尝试在未认证的情况下使用Salesforce工具
  • 您的令牌已过期
  • 发生身份验证错误
  • 需要初次设置

🧠 智能学习系统

为什么学习很重要?

每个Salesforce安装都是独一无二的,包括:

  • 自定义对象如“TimeTracking__c”、“Project__c”、“CustomerCare__c”
  • 标准对象上的自定义字段
  • 特定的工作流和验证规则
  • 个人数据结构

AI的常规训练模型只知道标准的Salesforce对象。如果没有了解您的特定安装,AI无法提供智能帮助。

学习是如何工作的?

  1. 一次性分析salesforce_learn分析您的整个安装
  2. 本地文档:所有对象、字段和关系都存储在本地
  3. 智能支持:Claude可以做出精确的建议并回答复杂的问题

示例工作流程:

您:“2025年7月是否有任何时间跟踪条目?”

没有学习:
❌ Claude:“我不认识名为'TimeTracking'的对象。”

有了学习:
✅ Claude:“我正在检查'TimeTracking__c'对象,查找2025年7月的条目……”
   自动执行正确的SOQL查询

何时应使用学习?

  • 安装初期 - 安装后一次
  • 重大变更后 - 新增自定义对象时
  • 遇到问题时 - 当Claude找不到对象或字段时

学习了什么?

  • 所有SObjects(标准和自定义)
  • 所有字段及其数据类型和