← 返回目录
S

Salesforce DX MCP Server

官方
面向大语言模型的官方 Salesforce DX 工具集,用于读取和操作 Salesforce 组织。
GitHub 源仓库 ↗
★ 462 Stars 分类 · 开发工具 非常热门 源版本 670234dbdca4
61FMRS · C
可靠性
9/20
安全与权限
9/20
维护活跃度
14/20
文档质量
16/20
安装易用性
13/20

官方维护、功能覆盖面广的 Salesforce 开发者 MCP 服务器,工具集丰富但需要本地 CLI 授权与谨慎的组织访问范围配置。

查看 FMRS 评分方法 →

Salesforce DX MCP Server 由 salesforcecli 官方维护,是 Model Context Protocol 的实现,让大语言模型能够安全地与本地已授权的 Salesforce 组织交互。通过 npx 启动 @salesforce/mcp 包后,可用 --orgs 指定可访问的组织、用 --toolsets/--tools 精确控制启用的工具组,覆盖元数据部署与检索、SOQL 查询、Apex/Agent 测试、用户与权限集管理、Scratch Org 生命周期、DevOps Center 工作项、代码静态分析(Code Analyzer)、Aura 到 LWC 迁移专家指导,以及移动端 LWC 能力文档等六十余个工具。默认只启用已正式发布(GA)的工具,需要加 --allow-non-ga-tools 才能使用尚在预览阶段的工具。

工具能力

get_username
确定用于 Salesforce 操作的用户名或别名,包括默认组织和 Dev Hub。
resume_tool_operation
恢复一个未被其他工具完成的长时间运行操作。
run_soql_query
对 Salesforce 组织执行 SOQL 查询。
check_devops_center_commit_status
检查已提交到 DevOps Center 的工作项的当前状态。
checkout_devops_center_work_item
按名称检出所选工作项关联的分支。
commit_devops_center_work_item
提交 SFDX 项目变更并在 DevOps Center 中登记提交 SHA。
create_devops_center_pull_request
将本地变更提交到 DevOps Center 工作项的功能分支。
detect_devops_center_merge_conflict
检测所选工作项或指定源分支中的合并冲突。
list_devops_center_projects
列出指定组织中的所有 DevOps Center 项目。
list_devops_center_work_items
列出指定 DevOps Center 项目下的所有工作项。
create_devops_center_work_item
在所选项目中创建新的 DevOps Center 工作项。
update_devops_center_work_item_status
将工作项状态设置为“进行中”或“待推广”。
promote_devops_center_work_item
将已批准的工作项推广到 DevOps Center 流水线的下一阶段。
resolve_devops_center_deployment_failure
诊断并解决部署失败问题。
resolve_devops_center_merge_conflict
对合并冲突应用所选的解决方式。
enrich_metadata
在 DX 项目中丰富来自组织的元数据。
create_aura_blueprint_draft
为 Aura 组件迁移创建全面的产品需求文档(PRD)蓝图草稿。
enhance_aura_blueprint_draft
以专家分析增强现有的 PRD 草稿蓝图并解决未知项。
orchestrate_aura_migration
编排完整的 Aura 到 LWC 迁移工作流。
transition_prd_to_lwc
提供从 Aura 规格创建 LWC 组件的迁移桥接指导。
create-custom-rule
根据提供的 Apex 代码示例创建基于 XPath 的自定义 PMD 规则。
describe_code_analyzer_rule
获取 Code Analyzer 规则的描述。
generate_xpath_prompt
根据 AST 上下文构建指导 XPath 编写的提示词,用于创建自定义规则。
list_code_analyzer_rules
根据多种条件筛选 Code Analyzer 规则。
query_code_analyzer_results
查询 Code Analyzer 结果 JSON 文件并返回筛选后的违规项。
run_code_analyzer
对代码执行静态分析,检查最佳实践、安全漏洞与性能问题。
create_lwc_component_from_prd
根据 PRD 规格创建结构完整、遵循最佳实践的 LWC 组件。
create_lwc_jest_tests
为 LWC 组件生成包含覆盖率和 Mock 的 Jest 测试套件。
review_lwc_jest_tests
审查并验证 LWC 组件的 Jest 测试实现。
create_lightning_type
为 Salesforce 应用、Agent 动作、LWC 及 Lightning 平台集成提供自定义 Lightning 类型(CLT)创建指导。
explore_slds_blueprints
按名称、类别、Lightning 组件、CSS 类或样式钩子检索 SLDS 蓝图规格。
guide_design_general
提供 SLDS 通用指南与 LWC 最佳实践,涵盖无障碍、响应式设计等。
guide_component_accessibility
提供 LWC 组件的无障碍指南与测试说明。
guide_lwc_best_practices
提供 LWC 开发最佳实践与编码规范指导。
guide_lwc_development
提供 LWC 开发工作流与实现指南。
guide_lwc_rtl_support
提供从右到左(RTL)国际化支持与开发指导。
guide_lws_security
根据产品安全准则和 Lightning Web Security 指南提供安全分析。
guide_slds_blueprints
提供全面的 SLDS 蓝图指南、参考文档及按类别索引。
guide_utam_generation
提供 UI 测试自动化模型(UTAM)页面对象生成指南。
lwc-doc-error
根据错误代码检索 LWC 错误消息及其静态修复指导。
reference_lwc_compilation_error
通过错误代码在已归档的知识库中查找 LWC 编译错误的模式、原因与修复方法。
guide_slds_styling
检索 SLDS 样式钩子指导与参考文档。
explore_slds_styling
支持精确、模糊、前缀及通配符匹配的 SLDS 样式钩子搜索。
guide_lbc_usage
提供 Lightning 基础组件索引及简要说明,帮助确定适用组件。
explore_lbc_components
根据 Lightning 基础组件名称列表返回完整 API 文档。
create_lds_graphql_mutation_query
提供创建 GraphQL 变更(mutation)查询的指导。
create_lds_graphql_read_query
为 LDS 创建 GraphQL 读取查询。
explore_lds_uiapi
探索并记录 Lightning Design System UI API 的能力。
fetch_lds_graphql_schema
获取 LDS 的 GraphQL Schema 结构。
guide_lds_data_consistency
提供 LDS 组件的数据一致性模式与最佳实践。
guide_lds_development
提供 LDS 开发指南与组件集成方法。
guide_lds_graphql
提供 LDS GraphQL 使用模式与指南。
guide_lds_referential_integrity
提供 LDS 数据管理的引用完整性模式。
orchestrate_lds_data_requirements
分步指导分析和澄清 LDS 数据需求,生成可用于 PRD 的规格。
test_lds_graphql_query
针对已连接的 Salesforce 组织测试 GraphQL 查询并返回结果。
guide_figma_to_lwc_conversion
将 Figma 设计转换为 LWC 组件规格。
guide_lo_migration
提供将 Lightning Out(beta)应用转换为 Lightning Out 2.0 的指导。
run_lwc_accessibility_jest_tests
为 LWC 组件提供无障碍测试工具与 Jest 集成。
verify_aura_migration_completeness
提供 Aura 到 LWC 迁移完整性清单与验证。
orchestrate_lwc_component_creation
为整个 Aura 到 LWC 迁移过程提供指导。
orchestrate_lwc_component_optimization
为 LWC 组件提供性能优化与最佳实践指导。
orchestrate_lwc_component_testing
提供全面的测试工作流与测试生成指导。
orchestrate_lwc_slds2_uplift
提供升级到 SLDS 2 的迁移指导。
validate_and_optimize
返回验证运行手册,指示代理运行一系列验证器(无障碍、安全、最佳实践等)、生成 SARIF 问题并评分。
score_issues
根据 SARIF 问题计算 0-100 的就绪度评分与质量等级(draft、prototype、review-for-production)。
deploy_metadata
将元数据从 DX 项目部署到组织。
retrieve_metadata
将元数据从组织检索到 DX 项目。
create_mobile_lwc_app_review
为 Salesforce LWC 应用评价服务提供 TypeScript API 文档指导。
create_mobile_lwc_ar_space_capture
为 Salesforce LWC AR 空间捕获功能提供 TypeScript API 文档指导。
create_mobile_lwc_barcode_scanner
为 Salesforce LWC 条码扫描功能提供 TypeScript API 文档指导。
create_mobile_lwc_biometrics
为 Salesforce LWC 生物识别服务提供 TypeScript API 文档指导。
create_mobile_lwc_calendar
为 Salesforce LWC 日历服务提供 TypeScript API 文档指导。
create_mobile_lwc_contacts
为 Salesforce LWC 联系人管理功能提供 TypeScript API 文档指导。
create_mobile_lwc_document_scanner
为 Salesforce LWC 文档扫描功能提供 TypeScript API 文档指导。
create_mobile_lwc_geofencing
为 Salesforce LWC 地理围栏服务提供 TypeScript API 文档指导。
create_mobile_lwc_location
为 Salesforce LWC 位置服务提供 TypeScript API 文档指导。
create_mobile_lwc_nfc
为 Salesforce LWC NFC 服务提供 TypeScript API 文档指导。
create_mobile_lwc_payments
为 Salesforce LWC 支付服务提供 TypeScript API 文档指导。
get_mobile_lwc_offline_analysis
分析 LWC 组件的移动端专属问题,提供离线兼容性与性能改进建议。
get_mobile_lwc_offline_guidance
提供结构化审查说明,用于检测和修复 LWC 组件中的移动离线代码违规。
create_org_snapshot
创建 Scratch Org 快照。
create_scratch_org
创建 Scratch Org。
delete_org
删除本地已授权的 Salesforce Scratch Org 或沙箱。
list_all_orgs
列出所有已配置的 Salesforce 组织,可选检查连接状态。
open_org
在浏览器中打开组织。
scan_apex_class_for_antipatterns
分析 Apex 类文件的性能反模式并给出修复建议。
run_agent_test
在组织中执行 Agent 测试。
run_apex_test
在组织中执行 Apex 测试。
assign_permission_set
为当前用户或代表其他用户分配权限集。

安装接入

  1. 使用 Salesforce CLI 提前在本机授权目标组织(sf org login web 或 IDE 中的“SFDX: Authorize an Org”命令)。
  2. 在 MCP 客户端的配置文件中添加一个服务器条目,命令为 npx,参数为 -y @salesforce/mcp,并附加 --orgs(必填,如 DEFAULT_TARGET_ORG)、--toolsets(如 orgs,metadata,data,users)等标志。
  3. 按需添加 --tools 指定额外单个工具,或加 --allow-non-ga-tools 启用预览版工具。
  4. 保存配置后重启/重新加载 MCP 客户端,npx 会自动拉取并运行 @salesforce/mcp 包(无需手动安装)。
  5. 如遇问题可加 --debug 查看调试日志(并非所有客户端都会展示 MCP 日志)。
claude_desktop_config.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"]}}}

选型与风险

适合谁

  • 已安装并使用 Salesforce CLI/DX 项目的开发者
  • 需要在 AI 编码助手中直接操作 Salesforce 元数据、Apex 与 LWC 的团队
  • 从 Aura 迁移到 LWC 或采用 DevOps Center 流程的项目

不适合谁

  • 没有本地 Salesforce CLI 环境或未授权任何组织的用户
  • 只需简单只读查询、不希望为完整工具集付出较大上下文开销的场景(可通过 --toolsets 精简,但默认工具集仍较大)

所需权限

  • 需要预先通过 `sf org login web` 等方式在本机授权 Salesforce 组织
  • 按 --orgs 配置可访问指定组织、默认组织/Dev Hub,或(谨慎使用)所有已授权组织
  • 部分工具具备写权限,如部署/检索元数据、创建或删除 Scratch Org、分配权限集、提交 DevOps Center 工作项

风险与副作用

  • `ALLOW_ALL_ORGS` 会让服务器访问所有本地已授权组织,配置不当可能波及生产组织
  • `deploy_metadata`、`delete_org` 等工具可对组织进行实际变更或删除操作,误操作有数据/配置风险
  • 默认启用遥测(telemetry),如涉及隐私合规需求应显式加 `--no-telemetry` 关闭
  • `DEFAULT_TARGET_ORG`/`DEFAULT_TARGET_DEV_HUB` 会在每次工具调用时动态解析当前默认组织,切换默认组织会改变实际可访问的组织范围

常见排障

  1. 确认已用 `sf org login web` 或 IDE 命令完成组织授权,且 --orgs 中的用户名/别名或令牌正确
  2. 检查 --toolsets 与 --tools 的名称拼写是否与文档一致,工具缺失时确认是否需要 --allow-non-ga-tools
  3. 若需要查看运行日志,加 --debug,但注意并非所有 MCP 客户端都会展示该输出
  4. 确保 `-y @salesforce/mcp` 部分未被修改,否则 npx 可能无法自动安装/更新包

使用场景

在 IDE 或 AI Agent 中查询、部署和检索 Salesforce 组织元数据
运行 SOQL 查询、Apex 测试与 Agent 测试并直接获取结果
借助专家工具将 Aura 组件迁移到 Lightning Web Components
对 Apex 代码进行静态分析(Code Analyzer)并生成自定义规则
通过 DevOps Center 工具管理工作项、检测并解决合并冲突
管理 Scratch Org 生命周期与权限集分配

支持客户端

Claude Code完整支持
VS Code (Copilot)完整支持
Cline完整支持
Cursor完整支持
Trae部分支持
Windsurf部分支持
Zed部分支持