kodey-ai-salesforce-mcp-server

mcp

用于与 Salesforce 组织交互的 MCP 服务

反馈

在此处报告错误和问题。
如需提出功能请求及其他相关话题，请在此处发起讨论。

Salesforce DX MCP 服务概述（开发者预览）

Salesforce DX MCP 服务是一种专用的模型上下文协议（MCP）实现，旨在促进大模型（LLM）与 Salesforce 组织之间的无缝交互。此 MCP 服务提供一套强大的工具和功能，让大模型能够安全地读取、管理和操作 Salesforce 资源。

主要功能：

• 通过大模型驱动的工具直接与 Salesforce 组织交互。
• 使用 TypeScript 库安全访问（不通过 shell 调用 sf Salesforce CLI）。
• 避免以纯文本形式暴露机密信息，从而提升安全性。
• 通过组织允许列表实现精细的访问控制。
• 模块化工具架构，便于扩展。

注意：Salesforce DX MCP 服务目前处于开发者预览阶段。除非或直至 Salesforce 在文档、新闻稿或公开声明中宣布正式发布，否则此功能不会普遍开放。所有命令、参数及其他功能随时可能更改或弃用，恕不另行通知。请勿使用这些命令或工具开发功能。随着我们不断改进和完善实现，可用功能和工具可能会有所变化。我们欢迎反馈和贡献，以帮助塑造此项目的未来。

安全功能

Salesforce DX MCP 服务的设计将安全性置于首位。

• 直接使用 TypeScript 库

  • 大幅减小 MCP 服务的体积。
  • 显著降低远程代码执行（RCE）的风险。

• 配置中无需机密信息

  • 消除纯文本机密信息暴露的风险。
  • 访问用户计算机上现有的（加密）身份验证文件。
  • 对身份验证信息的键值实施允许列表，防止敏感数据暴露。

• 不会通过 MCP 工具暴露机密信息

  • 防止其他工具访问未加密的令牌。
  • 工具传递用户名，而不是令牌。

• 精细的访问控制

  • MCP 服务只能访问已明确加入允许列表的组织的身份验证信息。
  • 用户在启动服务时指定允许访问的组织。

Agentforce for Developers 包含 Salesforce DX MCP 服务

Agentforce for Developers 是一款 AI 驱动的 Salesforce 开发者工具，可作为易于安装的 Visual Studio Code（VS Code）扩展使用。它包含 Dev Agent（开发者预览版），这是一位智能编码伙伴，能够提供信息，最重要的是，还能采取行动。借助由 MCP 提供支持的 Agent 式聊天，Dev Agent 可以直接在 VS Code 中自动执行命令和复杂工作流。

Salesforce DX MCP 服务已在 Agentforce for Developers 中预先配置，因此安装 VS Code 扩展后即可立即开始使用 DX MCP 工具。

如需了解更多信息，请参阅设置 Agentforce for Developers和与 Dev Agent 聊天（开发者预览版）。

开始使用 VS Code 作为客户端

想立即体验并看看它有何特别之处？请继续阅读！ 此示例使用 Visual Studio Code（VS Code）作为 MCP 客户端。使用 Salesforce DX MCP Server 配置好后，你就可以使用 GitHub Copilot 和自然语言轻松执行典型的 Salesforce DX 开发任务，例如列出已授权的 org、查看 org 记录，以及部署或检索元数据。

不过，你并不局限于只使用 VS Code 和 Copilot 作为 MCP 客户端！如前所述，你可以使用预先配置了 DX MCP Server 的 Agentforce for Developers。你也可以配置许多其他客户端来使用 Salesforce DX MCP Server，例如 Cursor、Cline、Claude Desktop、Zed、Windsurf 等。

开始之前

为了获得最佳的入门体验，请确保已在计算机上设置好 Salesforce DX 环境。具体来说：

• 在计算机上安装 Salesforce CLI。
• 在计算机上安装 VS Code。
• 创建 Salesforce DX 项目，并在 VS Code 中打开。你也可以克隆示例仓库，例如 dreamhouse-lwc，这是一个可直接使用的 DX 项目，其中包含简单的 Salesforce 应用、元数据和测试数据。
• 至少授权一个 Salesforce org，以便在 DX 项目中使用。你也可以创建临时 org。

开始操作

1. 在 DX 项目根目录下创建 .vscode/mcp.json 文件，并添加以下 JSON：

   {
     "servers": {
       "Salesforce DX": {
         "type": "stdio",
         "command": "npx",
         "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG", "--toolsets", "all"]
       }
     }
   }
   

   你也可以通过编辑 VS Code settings.json 文件，在 mcp:servers 部分中添加类似的 JSON 片段，以全局配置 MCP 服务。

   --orgs 标志为必填项，用于指定允许 MCP 服务访问的已授权 org。--toolsets 和 --tools 标志用于指定服务启动时启用的工具。有关这些标志可用的值，请参阅配置 DX MCP Server。

2. 打开 VS Code，前往 View -> Command Palette，然后输入 MCP: List Servers。

   提示：你也可以按 Ctrl+Shift+P（Windows 或 Linux）或 Command-Shift-P（macOS）打开命令面板。

3. 点击 Salesforce DX，然后点击 Start Server。

   在 Output 选项卡中查看服务状态。

4. 在命令面板中运行 Chat: Open Chat (Agent)，以启动新的 GitHub Copilot 聊天会话。

   确保 Copilot 聊天窗口处于 Agent 模式；如果处于 Ask 或 Edit 模式，请使用小型下拉菜单切换模式。

5. 在 GitHub Copilot 聊天窗口中，使用自然语言说明你想要执行的操作。MCP 服务会确定要使用哪个已配置的工具，然后向你展示该工具及其他信息。点击 Continue 以运行工具并查看请求结果。

   试试以下示例：

   • 列出我的所有 org。
   • 哪些是我当前启用的临时 org？
   • 显示别名为 my-org 的 org 中的所有客户。
   • 将项目中的所有内容部署到别名为 my-org 的 org。
   • 你发现 MyApexClass.cls 文件中的 Apex 代码存在性能或安全问题吗？
   • 我发现 Apex 代码违反了 pmd:ApexCRUDViolation 规则；你能介绍一下这条规则吗？

6. 要停止、重启或查看 MCP 服务配置，请运行 MCP: List Servers 命令，点击 Salesforce DX，然后点击相应选项。

通过 Smithery 安装

要通过 Smithery 自动安装 salesforce-mcp-kodey：

npx -y @smithery/cli install @kodey-ai/salesforce-mcp-kodey

配置 DX MCP 服务

通过向 args 选项传入标志来配置 Salesforce DX MCP 服务。将标志名称和值分别用双引号括起来，并用逗号分隔所有标志和值。有些标志是布尔值，无需指定值。

此示例展示了两个需要字符串值的标志（--orgs 和 --toolsets）以及一个布尔标志（--allow-non-ga-tools）：

     "servers": {
       "Salesforce DX": {
         "type": "stdio",
         "command": "npx",
         "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG", "--toolsets", "all", "--allow-non-ga-tools"]
       }
     }

"-y", "@salesforce/mcp" 部分会告知 npx 自动安装 @salesforce/mcp 软件包，而不是请求许可。请勿更改此内容。

以下是可传入 args 选项的标志。

标志名称	描述	必需？	备注
--orgs	一个或多个已在本地授权的组织。	是	必须至少指定一个组织。 有关可传入此标志的值，请参阅配置组织。
--toolsets	按功能划分的工具集，可选择要启用的工具集。	否	设置为 "all" 可启用所有工具集中的所有工具。 有关可传入此标志的值，请参阅配置工具集。
--tools	要启用的单个工具名称。	否	可以将此标志与 --toolsets 标志结合使用。例如，可以启用一个工具集中的所有工具，以及另一个工具集中的单个工具。
--no-telemetry	用于禁用遥测（自动收集数据以进行监控和分析）的布尔标志。	否	默认启用遥测；指定此标志即可禁用遥测。
--debug	用于要求 DX MCP 服务输出调试日志的布尔标志。	否	默认禁用调试模式。 **注意：**并非所有 MCP 客户端都会显示 MCP 日志，因此此标志可能无法在所有 IDE 中生效。
--allow-non-ga-tools	用于允许 DX MCP 服务使用你指定的工具集或工具中的正式发布（GA）和非正式发布工具的布尔标志。	否	默认情况下，DX MCP 服务仅使用标记为 GA 的工具。
--dynamic-tools	（实验性）用于启用动态工具发现和加载的布尔标志。指定此标志后，DX MCP 服务会以一组精简的核心工具启动，并按需加载新工具。	否	此标志有助于减小初始上下文大小并提升大模型性能。默认禁用动态工具发现。 **注意：**此功能可在 VSCode 和 Cline 中使用，但在其他环境中可能无法使用。

配置组织

Salesforce MCP 工具需要一个组织，因此配置 MCP 服务时必须包含必需的 --orgs 标志，以指定至少一个已授权组织。多个值之间用逗号分隔。

在 MCP 服务访问组织之前，必须先在计算机上明确授权这些组织。请使用 org login web Salesforce CLI 命令，或在命令面板中使用 VS Code SFDX: Authorize an Org 命令。

以下是 --orgs 标志可用的值：

• DEFAULT_TARGET_ORG - 允许访问默认组织。如果你已在 DX 项目中设置本地默认组织，MCP 服务会使用该组织；否则，服务会使用全局设置的默认组织。
• DEFAULT_TARGET_DEV_HUB - 允许访问默认 Dev Hub 组织。如果你已在 DX 项目中设置本地默认 Dev Hub 组织，MCP 服务会使用该组织；否则，服务会使用全局设置的默认 Dev Hub 组织。
• ALLOW_ALL_ORGS - 允许访问所有已授权组织。请谨慎使用此值。
• <username or alias> - 通过指定组织的用户名或别名，允许访问该特定组织。

此示例展示了如何在为 VS Code 配置 MCP 服务时，指定 MCP 工具针对默认组织运行：

       "servers": {
         "Salesforce DX": {
           "type": "stdio",
           "command": "npx",
           "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG"]
         }
       }

此示例代码段展示了如何配置对默认 Dev Hub 组织以及用户名为 [email protected] 的组织的访问权限：

           "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_DEV_HUB,[email protected]"]

此示例代码段展示了如何配置对两个已在授权时指定别名的组织的访问权限：

           "args": ["-y", "@salesforce/mcp", "--orgs", "my-scratch-org,my-dev-hub"]

配置工具集

Salesforce DX MCP Server 支持工具集——一种根据需求有选择地启用不同 MCP 工具组的方式。这样，你可以只使用所需工具运行 MCP 服务，从而减少上下文。

配置 Salesforce DX MCP Server 时，使用 --toolsets 标志指定工具集。多个工具集之间用逗号分隔。将 --toolsets 设置为 all 可注册所有可用工具集。

以下是可用的工具集。

工具集	描述
all	启用所有工具集中的所有可用工具。
orgs	用于管理已授权组织的工具。
data	用于管理组织中数据的工具，例如列出所有客户。
users	用于管理组织用户的工具，例如分配权限集。
metadata	用于在组织和 DX 项目之间部署和检索元数据的工具。
testing	用于测试代码和功能的工具
other	其他实用工具，例如使用 Salesforce Code Analyzer 对代码进行静态分析的工具。
mobile	用于移动开发和相关功能的工具。
mobile-core	专注于核心移动功能的移动工具子集。
aura-experts	提供 Aura 组件分析、蓝图设计和迁移专业知识的工具。
lwc-experts	用于辅助 LWC 开发、测试、优化和最佳实践的工具。

此示例展示了在为 VS Code 配置 MCP 服务时，如何启用 data、orgs、metadata 和 other 工具集：

       "servers": {
         "Salesforce DX": {
           "type": "stdio",
           "command": "npx",
           "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG", "--toolsets", "data,orgs,metadata,other"]
         }
       }

配置工具

Salesforce DX MCP Server 还支持注册单个工具。你可以将其与工具集结合使用，进一步精细调整已注册的工具。

配置 Salesforce DX MCP Server 时，使用 --tools 标志启用特定工具。多个工具之间用逗号分隔。--tools 标志为可选项。

此示例展示了在为 VS Code 配置 MCP 服务时，如何启用 orgs 和 metadata 工具集，以及 run_soql_query 和 run_apex_test 工具：

       "servers": {
         "Salesforce DX": {
           "type": "stdio",
           "command": "npx",
           "args": [
              "-y",
              "@salesforce/mcp", 
              "--orgs", 
              "DEFAULT_TARGET_ORG", 
              "--toolsets",
              "orgs,metadata"
              "--tools",
              "run_soql_query,run_apex_test"
            ]
         }
       }

核心工具集（始终启用）

包含以下工具：

• get_username - 确定 Salesforce 操作适用的用户名或别名，支持默认 org 和 Dev Hub。
• resume_tool_operation - 恢复由其他工具启动但尚未完成的长时间运行操作。

Orgs 工具集

包含以下工具：

• list_all_orgs - 列出所有已配置的 Salesforce org，可选择检查连接状态。
• create_org_snapshot -（NON-GA）创建临时 org 快照。
• create_scratch_org -（NON-GA）创建临时 org。
• delete_org -（NON-GA）删除本地已授权的 Salesforce 临时 org 或沙盒。
• org_open -（NON-GA）在浏览器中打开 org。

**注意：**标记为 NON-GA 的工具尚未正式发布。要使用它们，请指定 --allow-non-ga-tools 标志。

Data 工具集

包含以下工具：

• run_soql_query - 对 Salesforce org 运行 SOQL 查询。

Users 工具集

包含以下工具：

• assign_permission_set - 为用户分配权限集，或代表其他用户分配权限集。

Metadata 工具集

包含以下工具：

• deploy_metadata - 将元数据从 DX 项目部署到 org。
• retrieve_metadata - 将元数据从 org 检索到 DX 项目。

Testing 工具集

包含以下工具：

• run_agent_test - 在 org 中执行 Agent 测试。
• run_apex_test - 在 org 中执行 Apex 测试。

移动工具集

包含以下尚未正式发布的工具：

• create_mobile_lwc_app_review -（NON-GA）提供 Salesforce LWC App Review Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现应用审核功能提供专家指导。
• create_mobile_lwc_ar_space_capture -（NON-GA）提供 Salesforce L WC AR Space Capture 的 TypeScript API 文档，为在 Lightning Web Components 中实现 AR 空间捕获功能提供专家指导。
• create_mobile_lwc_barcode_scanner -（NON-GA）提供 Salesforce LWC Barcode Scanner 的 TypeScript API 文档，为在 Lightning Web Components 中实现条码扫描功能提供专家指导。
• create_mobile_lwc_biometrics -（NON-GA）提供 Salesforce LWC Biometrics Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现生物识别身份验证功能提供专家指导。
• create_mobile_lwc_calendar -（NON-GA）提供 Salesforce LWC Calendar Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现日历集成功能提供专家指导。
• create_mobile_lwc_contacts -（NON-GA）提供 Salesforce LWC Contacts Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现联系人管理功能提供专家指导。
• create_mobile_lwc_document_scanner -（NON-GA）提供 Salesforce LWC Document Scanner 的 TypeScript API 文档，为在 Lightning Web Components 中实现文档扫描功能提供专家指导。
• create_mobile_lwc_geofencing -（NON-GA）提供 Salesforce LWC Geofencing Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现地理围栏功能提供专家指导。
• create_mobile_lwc_location -（NON-GA）提供 Salesforce LWC Location Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现位置服务提供专家指导。
• create_mobile_lwc_nfc -（NON-GA）提供 Salesforce LWC NFC Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现 NFC 功能提供专家指导。
• create_mobile_lwc_payments -（NON-GA）提供 Salesforce LWC Payments Service 的 TypeScript API 文档，为在 Lightning Web Components 中实现支付处理功能提供专家指导。
• get_mobile_lwc_offline_analysis -（NON-GA）分析 Lightning Web Components 中特定于移动端的问题，并针对移动端离线兼容性和性能改进提供详细建议。
• get_mobile_lwc_offline_guidance -（NON-GA）提供结构化审核说明，用于检测和修复 Salesforce Mobile Apps 中 Lightning Web Components 的移动端离线代码违规。

注意： 标记为 NON-GA 的工具尚未正式发布；使用这些工具时，请指定 --allow-non-ga-tools 标志。

Mobile-core 工具集

包含以下尚未普遍提供的基础移动端工具：

• create_mobile_lwc_barcode_scanner -（NON-GA）提供 Salesforce LWC 条码扫描器的 TypeScript API 文档，为在 Lightning Web Components 中实现条码扫描功能提供专业指导。
• create_mobile_lwc_biometrics -（NON-GA）提供 Salesforce LWC 生物识别服务的 TypeScript API 文档，为在 Lightning Web Components 中实现生物识别身份验证功能提供专业指导。
• create_mobile_lwc_location -（NON-GA）提供 Salesforce LWC 位置服务的 TypeScript API 文档，为在 Lightning Web Components 中实现位置服务提供专业指导。
• get_mobile_lwc_offline_analysis -（NON-GA）分析 Lightning Web Components 中特定于移动端的问题，并提供详细建议，以提升移动端离线兼容性和性能。
• get_mobile_lwc_offline_guidance -（NON-GA）提供结构化审查说明，用于检测和修复 Salesforce Mobile Apps 的 Lightning Web Components 中违反移动端离线要求的代码。

注意： 标记为 NON-GA 的工具尚未普遍提供；使用它们时，请指定 --allow-non-ga-tools 标志。

Aura 专家工具集

• create_aura_blueprint_draft -（GA） 为 Aura 组件迁移创建全面的产品需求文档（PRD）蓝图。分析 Aura 组件文件，并生成适用于 LWC 迁移、且与框架无关的规范，其中包括业务需求、技术模式和迁移指南。

• enhance_aura_blueprint_draft -（GA） 通过专家分析和未知项处理，完善现有的 PRD 草稿。根据草稿蓝图应用 Aura 专家知识，处理依赖项、补充技术见解，并改进迁移规范，为 LWC 实现提供更好的指导。

• transition_prd_to_lwc -（GA） 提供迁移桥接指导，帮助根据 Aura 规范创建 LWC 组件。根据增强后的 PRD 生成具体的实现指导、平台服务映射，以及构建等效 LWC 组件的分步说明。

• orchestrate_aura_migration -（GA） 编排从 Aura 到 LWC 的完整迁移工作流，为整个迁移过程提供端到端指导，从初步分析到最终实现，涵盖最佳实践、工具建议和质量保证步骤。

注意： 标记为 NON-GA 的工具尚未普遍提供；使用它们时，请指定 --allow-non-ga-tools 标志。

Lwc 专家工具集

组件开发

• create_lwc_component -（GA）根据 PRD 规范创建完整的 LWC 组件，采用适当的结构和最佳实践
• create_lwc_jest_tests -（GA）为 LWC 组件生成全面的 Jest 测试套件，包含覆盖率和模拟
• review_lwc_jest_tests -（GA）审查并验证 LWC 组件的 Jest 测试实现

开发指南

• guide_lwc_accessibility -（GA）提供 LWC 组件的无障碍指南和测试说明
• guide_lwc_best_practices -（GA）提供 LWC 开发最佳实践和编码标准指导
• guide_lwc_development -（GA）提供全面的 LWC 开发工作流和实现指南
• guide_lwc_rtl_support -（GA）提供从右到左的国际化支持和 RTL 开发指导
• guide_uplift_ai_metadata -（GA）增强 LWC 组件的 AI 元数据
• guide_lwc_slds2_uplift_linter_fixes -（GA）结合给定的 LWC 代码和 slds-linter 输出，利用 SLDS2 知识分析并修复问题
• guide_lwc_security -（GA）根据产品安全指南和 Lightning Web Security 指南进行全面的安全分析

工作流工具

• orchestrate_lwc_component_creation -（GA）分步组件创建工作流指导
• orchestrate_lwc_component_optimization -（GA）LWC 组件性能优化和最佳实践
• orchestrate_lwc_component_testing -（GA）全面的测试工作流和测试生成指导
• orchestrate_lwc_slds2_uplift -（GA）升级到 SLDS2 设计系统的迁移指导

LDS（Lightning Design System）工具

• explore_lds_uiapi -（GA）探索并记录 Lightning Design System UI API 的功能
• guide_lds_data_consistency -（GA）LDS 组件的数据一致性模式和最佳实践
• guide_lds_development -（GA）LDS 开发指南和组件集成
• guide_lds_referential_integrity -（GA）LDS 数据管理的引用完整性模式

迁移和集成工具

• verify_aura_migration_completeness -（GA）Aura 到 LWC 迁移完整性检查清单和验证
• guide_figma_to_lwc_conversion -（GA）将 Figma 设计转换为 LWC 组件规范
• run_lwc_accessibility_jest_tests -（GA）LWC 组件的无障碍测试实用工具和 Jest 集成

注意： 标记为 NON-GA 的工具尚未普遍开放，请指定 --allow-non-ga-tools 标志以使用它们。

Code-Analyzer 工具集

包含以下尚未普遍开放的工具：

• run_code_analyzer -（NON-GA）使用 Salesforce Code Analyzer 对代码执行静态分析。包括验证代码是否符合最佳实践、检查安全漏洞，以及识别可能的性能问题。
• describe_code_analyzer_rule -（NON-GA）获取 Salesforce Code Analyzer 规则的说明，包括其所属引擎、严重程度和相关标签。

注意： 标记为 NON-GA 的工具尚未普遍开放，请指定 --allow-non-ga-tools 标志以使用它们。

配置其他客户端以使用 Salesforce DX MCP 服务

Cursor

要配置 Cursor 以配合 Salesforce DX MCP Server 使用，请将此代码片段添加到 Cursor 的 mcp.json 文件中：

{
  "mcpServers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG", "--toolsets", "all"]
    }
  }
}

Cline

要配置 Cline，请将此代码片段添加到 Cline 的 cline_mcp_settings.json 文件中：

{
  "mcpServers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp", "--orgs", "DEFAULT_TARGET_ORG", "--toolsets", "all"]
    }
  }
}

其他客户端

对于这些其他客户端，请参阅其文档，了解如何添加 MCP 服务，并遵循前文 VS Code 和 Cursor JSON 代码片段中的相同模式：

• Claude Desktop
• Zed
• Windsurf
• Trae

通过 Smithery 安装

要通过 Smithery 自动安装 salesforce-mcp-minimal：

npx -y @smithery/cli install @kodey-ai/salesforce-mcp-minimal