mcp

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

反馈

在此处报告错误和问题。
对于功能请求和其他相关主题，请在此处发起讨论。

Related MCP server: Salesforce DX MCP Server

文档

有关 Salesforce DX MCP Server 的常规文档，请参阅 Salesforce DX 开发人员指南中的此部分。这些文档包括：

• 全面概述，包括安全功能的详细信息。

• 快速入门指南。

• 在 MCP 客户端中配置服务器的多个示例。

• 用于调用核心 DX MCP 工具的示例提示。

此处是发布说明。

Salesforce DX MCP Server 概述

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

配置 DX MCP Server

通过更新关联的 MCP JSON 文件，为你的 MCP 客户端配置 Salesforce DX MCP Server；每个客户端略有不同，因此请查看你的 MCP 客户端文档以了解详细信息。有关更多示例，请参阅 MCP 客户端配置。

以下是一个在 VS Code 中使用 Copilot 的示例，你可以在项目中创建并更新 .vscode/mcp.json 文件：

{
  "servers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp",
              "--orgs", "DEFAULT_TARGET_ORG",
              "--toolsets", "orgs,metadata,data,users",
              "--tools", "run_apex_test",
              "--allow-non-ga-tools"]
    }
  }
}

前面示例中显示的 args 格式对所有 MCP 客户端都是相同的；这就是你为特定环境自定义 DX MCP Server 的方式。

注意：

• "-y", "@salesforce/mcp" 部分告诉 npx 自动安装 @salesforce/mcp 包，而不是请求许可。不要更改此部分。

• 有关可以传递给 args 选项的可能标志，以及可以传递给 --orgs、--toolsets 和 --tools 标志的可能值，请参阅以下部分：

  • args 选项的可用标志

  • 配置组织

  • 配置工具集

  • 配置工具

• 编写 args 选项时，请将标志名称及其值都用双引号括起来，并用逗号分隔所有标志和值。某些标志是布尔型的，不取值。

• 前面的示例显示了三个接受字符串值的标志（--orgs、--toolsets 和 --tools）和一个布尔标志（--allow-non-ga-tools）。此配置启动的 DX MCP Server 会启用 orgs、metadata、data 和 users 工具集中的所有 MCP 工具，以及一个名为 run_apex_tests 的特定工具。它还会启用这些已配置工具集中尚未正式发布（GA）的工具。

MCP 客户端配置

以下是在各种 MCP 客户端中配置 Salesforce DX MCP Server 的示例。

Claude Code

要将 Claude Code 配置为与 Salesforce DX MCP Server 配合使用，请将以下代码片段添加到项目中的 .mcp.json 文件：

{
  "mcpServers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp",
               "--orgs", "DEFAULT_TARGET_ORG",
               "--toolsets", "orgs,metadata,data,users",
               "--tools", "run_apex_test",
               "--allow-non-ga-tools"]
    }
  }
}

Cline

要将 Cline 配置为与 Salesforce DX MCP Server 配合使用，请将以下代码片段添加到你的 Cline cline_mcp_settings.json 文件中：

{
  "mcpServers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp@latest",
              "--orgs", "DEFAULT_TARGET_ORG",
              "--toolsets", "orgs,metadata,data,users",
              "--tools", "run_apex_test",
              "--allow-non-ga-tools"]
    }
  }
}

Cursor

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

{
  "mcpServers": {
    "Salesforce DX": {
      "command": "npx",
      "args": ["-y", "@salesforce/mcp@latest",
              "--orgs", "DEFAULT_TARGET_ORG",
              "--toolsets", "orgs,metadata,data,users",
              "--tools", "run_apex_test",
              "--allow-non-ga-tools"]
    }
  }
}

其他 MCP 客户端

对于这些其他客户端，请参阅其文档以了解如何添加 MCP 服务器，并按照前面示例中的相同模式配置 Salesforce DX MCP Server：

• Trae

• Windsurf

• Zed

"args" 选项的可用标志

这些是你可以传递给 args 选项的标志。

配置组织

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

在 MCP 服务器可以访问这些组织之前，你必须先在计算机上显式授权这些组织。使用 org login web Salesforce CLI 命令，或从命令面板中使用 VS Code 的 SFDX: Authorize an Org 命令。

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

[!NOTE] DEFAULT_TARGET_ORG 和 DEFAULT_TARGET_DEV_HUB 令牌会在每次工具调用时动态解析，而不是在服务器启动时固定。它们会跟踪工具所操作的当前工作目录的默认组织解析结果，因此切换默认组织（或在具有不同本地默认设置的目录中工作）会更改这些令牌允许访问的组织。这反映了 sf CLI 在你未传递 --target-org 时解析默认目标组织的方式。如果你希望将服务器锁定到一组固定的组织，而不考虑当前的默认设置，请向 --orgs 传递显式的用户名或别名，而不是 DEFAULT_TARGET_* 令牌。

配置工具集

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

在配置 Salesforce DX MCP Server 时，使用 --toolsets 标志来指定工具集。多个工具集之间用逗号分隔。

以下是可用的工具集。

配置工具

Salesforce DX MCP Server 还支持注册单个工具。这可以与工具集结合使用，以进一步微调已注册的工具。

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

以下各节列出了特定工具集中包含的所有工具。

[!NOTE] 标记为 NON-GA 的工具尚未正式发布。请指定 --allow-non-ga-tools 标志来使用它们。

Aura Experts 工具集

有关完整文档，请参阅 Lightning Web Components 开发人员指南 中的 使用 Aura 到 LWC 迁移工具。

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

• enhance_aura_blueprint_draft (GA) - 通过专家分析和未知项解析来增强现有的 PRD 草稿。获取蓝图草稿并应用专门的 Aura 专家知识来解决依赖关系、添加技术见解，并改进迁移规范以提供更好的 LWC 实现指导。

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

• transition_prd_to_lwc (GA) - 提供从 Aura 规范创建 LWC 组件的迁移桥接指导。获取增强后的 PRD 并生成具体的实现指导、平台服务映射以及构建等效 LWC 组件的分步说明。

Code Analysis 工具集

有关完整文档，请参阅 Salesforce Code Analyzer 开发人员指南 中的 使用 MCP 工具分析您的代码。

• create-custom-rule (NON-GA) - 根据提供的 Apex 代码示例创建基于 XPath 的自定义 PMD 规则。

• describe_code_analyzer_rule (GA) - 获取 Code Analyzer 规则的描述。

• generate_xpath_prompt (NON-GA) - 构建从 AST 上下文指导 XPath 编写的提示。在创建基于 XPath 的 PMD 自定义规则时调用。

• list_code_analyzer_rules (GA) - 根据多个条件选择 Code Analyzer 规则。

• query_code_analyzer_results (GA) - 查询 Code Analyzer 结果 JSON 文件并返回过滤后的违规项。支持严重性、类别/标签、引擎、规则和文件名等过滤器，以及前 N 项和排序。在运行 run_code_analyzer 后使用此工具读取生成的结果文件。完成后，此工具将向用户总结并解释过滤后的结果。

• run_code_analyzer (GA) - 对代码执行静态分析。此工具可以验证代码是否符合最佳实践、检查安全漏洞并识别可能的性能问题。如果生成了结果文件，它将返回一个包含结果文件绝对路径的 JSON，以及一个指示操作整体成功或失败的字符串。

Core 工具集（始终启用）

有关调用核心 DX MCP 工具的示例提示，请参阅 Salesforce DX 开发人员指南 中的 使用核心 Salesforce DX MCP 工具。

• get_username (GA) - 确定适用于 Salesforce 操作的适当用户名或别名，处理默认组织和 Dev Hub。

• resume_tool_operation (GA) - 恢复由另一个工具未完成的长时运行操作。

Data 工具集

有关调用核心 DX MCP 工具的示例提示，请参阅 Salesforce DX 开发人员指南 中的 使用核心 Salesforce DX MCP 工具。

• run_soql_query (GA) - 对 Salesforce 组织运行 SOQL 查询。

DevOps Center 工具集

有关完整文档，请参阅 Salesforce Help 中的 使用 DevOps Center MCP 工具解决合并冲突（托管包）。

• check_devops_center_commit_status (GA) - 检查已提交到 DevOps Center 的工作项当前状态。

• checkout_devops_center_work_item (GA) - 按名称选中与所选工作项关联的分支。

• commit_devops_center_work_item (GA) - 提交 SFDX 项目更改，并在 DevOps Center 中注册提交 SHA。

• create_devops_center_pull_request (GA) - 将本地更改提交到 DevOps Center 工作项的功能分支。

• detect_devops_center_merge_conflict (GA) - 检测所选工作项或指定源分支中的合并冲突。

• list_devops_center_projects (GA) - 列出特定组织中的所有 DevOps Center 项目。

• list_devops_center_work_items (GA) - 列出特定 DevOps Center 项目的所有工作项。

• create_devops_center_work_item (GA) - 在所选项目中创建新的 DevOps Center 工作项。

• update_devops_center_work_item_status (GA) - 将工作项状态设置为“进行中”或“可以推广”。

• promote_devops_center_work_item (GA) - 将已批准的工作项提升到 DevOps Center 流水线中的下一阶段。

• resolve_devops_center_deployment_failure (GA) - 诊断并解决部署失败。

• resolve_devops_center_merge_conflict (GA) - 将所选的解决方法应用于合并冲突。

丰富工具集

• enrich_metadata (NON-GA) - 在您的 DX 项目中丰富来自组织的元数据。

Lightning Web Components (LWC) 专家工具集

有关完整文档，请参阅 Lightning Web Components 开发指南中的将 DX MCP 工具用于 LWC。

组件开发

• create_lwc_component_from_prd (GA) - 基于 PRD 规范创建完整的 LWC 组件，具有正确的结构并遵循最佳实践。

• create_lwc_jest_tests (GA) - 为 LWC 组件生成包含覆盖率和模拟（mocking）的 Jest 测试套件。

• review_lwc_jest_tests (GA) - 审查并验证 LWC 组件的 Jest 测试实现。

开发指南

• create_lightning_type (GA) - 提供为 Salesforce 应用、代理操作、Lightning Web 组件和 Lightning Platform 集成创建自定义 Lightning 类型 (CLT) 的指导。

• explore_slds_blueprints (NON-GA) - 按名称、类别、Lightning 组件、CSS 类或样式钩子检索 SLDS 蓝图规范。

• guide_design_general (GA) - 为 Lightning Web 组件提供 SLDS 准则和最佳实践，包括可访问性、响应式设计和组件使用模式。

• guide_component_accessibility (GA) - 为 LWC 组件提供可访问性指南和测试说明。

• guide_lwc_best_practices (GA) - 提供 LWC 开发最佳实践和编码标准指导。

• guide_lwc_development (GA) - 提供 LWC 开发工作流和实现指南。

• guide_lwc_rtl_support (GA) - 提供从右到左 (RTL) 国际化支持和 RTL 开发指导。

• guide_lws_security (GA) - 根据产品安全指南和 Lightning Web Security 指南进行安全分析。

• guide_slds_blueprints (NON-GA) - 提供全面的 SLDS 蓝图指南、参考文档以及所有可用蓝图的按类别完整索引。

• guide_utam_generation (NON-GA) - 提供 UI 测试自动化模型 (UTAM) 页面生成指南和最佳实践。

• lwc-doc-error (GA) - 检索 LWC 错误消息的相关信息，包括根据错误代码解决该问题的静态指导。

• reference_lwc_compilation_error (GA) - 通过对照记录的错误模式、原因和修复方法知识库查找错误代码，来引用 LWC 编译错误。

• guide_slds_styling (NON-GA) - 检索 SLDS 样式钩子指南和参考文档。

• explore_slds_styling (NON-GA) - 搜索和探索 SLDS 样式钩子，支持精确查找、模糊匹配、前缀搜索和通配符模式。

• guide_lbc_usage (GA) - 提供可用 Lightning Base 组件的索引及简短描述，帮助开发者确定哪些组件适合其用例。

• explore_lbc_components (GA) - 输入 Lightning Base 组件名称列表，从 Markdown 知识文件中返回完整的 API 文档。

Lightning Data Service (LDS) 工具

• create_lds_graphql_mutation_query (GA) - 提供创建 GraphQL mutation 查询的指导。

• create_lds_graphql_read_query (GA) - 为 LDS 创建 GraphQL 读取查询。

• explore_lds_uiapi (GA) - 探索并记录 Lightning Design System UI API 的功能。

• fetch_lds_graphql_schema (GA) - 获取适用于 LDS 的 GraphQL 架构结构。

• guide_lds_data_consistency (GA) - 为 LDS 组件提供数据一致性模式和最佳实践。

• guide_lds_development (GA) - 提供 LDS 开发指南和组件集成。

• guide_lds_graphql (GA) - 提供 LDS GraphQL 使用模式和指南。

• guide_lds_referential_integrity (GA) - 为 LDS 数据管理提供引用完整性模式。

• orchestrate_lds_data_requirements (GA) - 提供逐步指导，以分析和澄清 LDS 数据需求，并生成可交付 PRD 的规范。

• test_lds_graphql_query (GA) - 针对已连接的 Salesforce org 测试 GraphQL 查询并返回结果。此工具是 GraphQL 查询创建工具的子工具，且只能在其工作流中调用。

迁移与集成工具

• guide_figma_to_lwc_conversion (GA) - 将 Figma 设计转换为 LWC 组件规范。

• guide_lo_migration (GA) - 提供将 Lightning Out (beta) 应用转换为 Lightning Out 2.0 应用的指导。

• run_lwc_accessibility_jest_tests (GA) - 为 LWC 组件提供可访问性测试工具和 Jest 集成。

• verify_aura_migration_completeness (GA) - 提供 Aura 到 LWC 迁移完整性检查清单和验证。

工作流工具

• orchestrate_lwc_component_creation (GA) - 提供整个 Aura 到 LWC 迁移过程的指导。

• orchestrate_lwc_component_optimization (GA) - 为 LWC 组件提供性能优化和最佳实践。

• orchestrate_lwc_component_testing (GA) - 提供全面的测试工作流和测试生成指导。

• orchestrate_lwc_slds2_uplift (NON-GA) - 提供升级到 SLDS 2 的迁移指导。

专家验证工具集

• validate_and_optimize (GA) - 返回一个验证运行手册，指示代理运行一组验证器（可访问性、安全、最佳实践等），生成 SARIF 问题，并对结果进行评分。

• score_issues (GA) - 根据 SARIF 问题计算就绪得分（0-100）和品质等级（draft、prototype、review-for-production）。

元数据工具集

有关调用核心 DX MCP 工具的示例提示，请参阅 Salesforce DX 开发指南中的使用核心 Salesforce DX MCP 工具。

• deploy_metadata (GA) - 将元数据从您的 DX 项目部署到组织。

• retrieve_metadata (GA) - 将元数据从您的组织检索到 DX 项目。

移动工具集

有关完整文档，请参阅 移动和离线开发指南中的使用 mobile 工具集。

• create_mobile_lwc_app_review (GA) - 提供 Salesforce LWC App Review Service 的 TypeScript API 文档，为在 LWC 组件中实现应用审核功能提供专家指导。

• create_mobile_lwc_ar_space_capture (GA) - 提供 Salesforce LWC AR Space Capture 的 TypeScript API 文档，为在 LWC 组件中实现 AR 空间捕获功能提供专家指导。

• create_mobile_lwc_barcode_scanner (GA) - 提供 Salesforce LWC Barcode Scanner 的 TypeScript API 文档，为在 LWC 组件中实现条码扫描功能提供专家指导。

• create_mobile_lwc_biometrics (GA) - 提供 Salesforce LWC Biometrics Service 的 TypeScript API 文档，为在 LWC 组件中实现生物识别功能提供专家指导。

• create_mobile_lwc_calendar (GA) - 提供 Salesforce LWC Calendar Service 的 TypeScript API 文档，为在 LWC 组件中实现日历集成功能提供专家指导。

• create_mobile_lwc_contacts (GA) - 提供 Salesforce LWC Contacts Service 的 TypeScript API 文档，为在 LWC 组件中实现联系人管理功能提供专家指导。

• create_mobile_lwc_document_scanner (GA) - 提供 Salesforce LWC Document Scanner 的 TypeScript API 文档，为在 LWC 组件中实现文档扫描功能提供专家指导。

• create_mobile_lwc_geofencing (GA) - 提供 Salesforce LWC Geofencing Service 的 TypeScript API 文档，为在 LWC 组件中实现地理围栏功能提供专家指导。

• create_mobile_lwc_location (GA) - 提供 Salesforce LWC Location Service 的 TypeScript API 文档，为在 LWC 组件中实现位置服务功能提供专家指导。

• create_mobile_lwc_nfc (GA) - 提供 Salesforce LWC NFC Service 的 TypeScript API 文档，为在 LWC 组件中实现 NFC 功能提供专家指导。

• create_mobile_lwc_payments - 提供 Salesforce LWC Payments Service 的 TypeScript API 文档，为在 LWC 组件中实现支付处理功能提供专家指导。

• get_mobile_lwc_offline_analysis (GA) - 分析 LWC 组件中移动设备相关的问题，并提供详细的移动设备离线兼容性和性能改进建议。

• get_mobile_lwc_offline_guidance (GA) - 提供结构化审查说明，以检测和修复 Salesforce 移动应用中 LWC 组件的移动离线代码违规。

mobile-core 工具集

有关完整文档，请参阅 移动和离线开发指南中的使用 mobile-core 工具集。

• create_mobile_lwc_barcode_scanner (GA) - 提供 Salesforce LWC Barcode Scanner 的 TypeScript API 文档，为在 LWC 组件中实现条码扫描功能提供专家指导。

• create_mobile_lwc_biometrics (GA) - 提供 Salesforce LWC Biometrics Service 的 TypeScript API 文档，为在 LWC 组件中实现生物功能提供专家指导。

• create_mobile_lwc_location (GA) - 提供 Salesforce LWC Location Service 的 TypeScript API 文档，为在 LWC 组件中实现位置服务功能提供专家指导。

• get_mobile_lwc_offline_analysis (GA) - 分析 LWC 组件中移动设备相关的问题，并提供详细的移动设备离线兼容性和性能改进建议。

• get_mobile_lwc_offline_guidance (GA) - 提供结构化审查说明，以检测和修复 Salesforce 移动应用中 LWC 组件的移动离线代码违规。

组织工具集

有关调用核心 DX MCP 工具的示例提示，请参阅 Salesforce DX 开发指南中的使用核心 Salesforce DX MCP 工具。

• create_org_snapshot（非正式发布版）—创建临时组织快照。

• create_scratch_org（非正式发布版）—创建临时组织。

• delete_org（非正式发布版）—删除本地授权的 Salesforce 临时组织或沙盒。

• list_all_orgs（正式发布版）—列出所有已配置的 Salesforce 组织，并可选择检查连接状态。

• open_org（非正式发布版）—在浏览器中打开一个组织。

规模产品工具集

有关完整文档，请参阅 mcp-provider-scale-products 子目录中的 README。

• scan_apex_class_for_antipatterns（正式发布版）—分析 Apex 类文件中的性能反模式，并提供修复建议。

测试工具集

有关调用核心 DX MCP 工具的示例提示，请参阅《Salesforce DX 开发人员指南》中的 使用核心 Salesforce DX MCP 工具。

• run_agent_test（正式发布版）—在您的组织中执行代理测试。

• run_apex_test（正式发布版）—在您的组织中执行 Apex 测试。

用户工具集

有关调用核心 DX MCP 工具的示例提示，请参阅《Salesforce DX 开发人员指南》中的 使用核心 Salesforce DX MCP 工具。

• assign_permission_set（正式发布版）—向用户或代表其他用户分配权限集。