mcpField
S
sf-metadata

sf-metadata

github.com/jaganpro开发4241.5k 次安装26 周前更新
代码仓库

关于 sf-metadata

sf-metadata 是用于 Salesforce 元数据生成和组织元数据查询的技能,涵盖对象、字段、验证规则、布局及权限集等。它将 Schema 检查与字段级安全和部署依赖规划结合起来。

主要功能

  1. 01生成元数据 XML
  2. 02使用 sf CLI 查询组织元数据
  3. 03检查 Schema 与字段类型
  4. 04规划权限集和字段级安全
  5. 05检查命名及部署依赖

适用场景

  1. 01按需求创建对象或字段元数据
  2. 02在编码或构建 Flow 前检查 Schema
  3. 03生成验证规则、布局或记录类型
  4. 04为自定义字段补充权限集配置

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jaganpro/sf-skills --skill sf-metadata

安装后在 Claude Code 中输入/sf-metadata确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

CREDITS.md
README.md
assets/fields/
checkbox-field.xml
currency-field.xml
date-field.xml
email-field.xml
formula-field.xml
lookup-field.xml
master-detail-field.xml
multi-select-picklist.xml
number-field.xml
phone-field.xml
picklist-field.xml
rollup-summary-field.xml
text-field.xml
textarea-field.xml
url-field.xml
assets/layouts/
page-layout.xml
assets/objects/
custom-object.xml
assets/permission-sets/
permission-set.xml
assets/profiles/
profile.xml
assets/record-types/
record-type.xml
assets/validation-rules/
validation-rule.xml
hooks/scripts/
generate_permission_set.py
run_validation.sh
validate_metadata.py
references/
best-practices-scoring.md
custom-object-example.md
field-and-cli-reference.md
field-types-example.md

详细介绍

sf-metadata:Salesforce 元数据生成与组织查询

当用户需要定义元数据或发现组织元数据时,使用此技能:自定义对象、字段、验证规则、记录类型、页面布局、权限集,或使用 sf CLI 检查架构。

此技能适用的任务

当工作涉及以下内容时,使用 sf-metadata:

  • 对象、字段、验证规则、记录类型、布局、配置文件或权限集元数据
  • .object-meta.xml、.field-meta.xml、.profile-meta.xml 及相关元数据文件
  • 在编写代码或处理 Flow 之前描述架构
  • 根据需求生成元数据 XML

以下情况请转交给其他技能:


先收集所需上下文

询问或推断:

  • 用户需要生成还是查询
  • 涉及的元数据类型
  • 目标对象 / 字段 / 包目录
  • 查询时所需的目标组织别名
  • 新建自定义对象或字段是否也应包含权限集 / FLS 生成

除非用户明确选择不需要,否则假定新建的自定义对象或字段需要后续处理权限集。


推荐工作流

1. 选择模式
模式适用情况
generation用户需要新的或更新后的元数据 XML
querying用户需要发现对象 / 字段 / 元数据
2. 从模板或 CLI 描述数据入手

生成时,使用以下目录中的资源:

  • assets/objects/
  • assets/fields/
  • assets/permission-sets/
  • assets/profiles/
  • assets/record-types/
  • assets/validation-rules/
  • assets/layouts/

查询时,优先使用 sf 元数据和 sobject describe 命令。

阅读较旧示例时需要了解近期的 SDR/CLI 支持情况:CnfgItemSourceDefinition、ExtlClntAppOauthSecuritySettings 和 UIBundle 现在已使用其当前名称受源代码支持。请参阅 references/metadata-types-reference.md。

3. 验证元数据质量

检查:

  • 命名约定
  • 结构正确性
  • 字段类型是否合适
  • 安全性 / FLS 影响
  • 下游部署依赖项
4. 默认规划权限影响

创建新的自定义字段或对象时:

  • 默认生成或更新 Permission Set,除非用户选择不需要
  • 为符合条件的自定义字段包含 fieldPermissions
  • 说明因 Salesforce 将其视为系统管理或始终可用而被排除的元数据类别
  • 请记住,仅有对象 CRUD 并不能让自定义字段可见
5. 移交部署

当用户需要推出元数据时,使用 sf-deploy。


重要规则

  • 部署后,字段级安全性往往是隐藏的阻碍
  • 对象权限 ≠ 字段权限
  • 优先使用权限集,而非以配置文件为中心的访问模式
  • 默认对新建的自定义对象和字段生成后续 Permission Set
  • 为符合条件的自定义字段包含 fieldPermissions,不要把 FLS 留作后续手动处理
  • 避免在公式或元数据逻辑中硬编码 ID
  • 在业务运营确有需要时,验证规则应有明确的绕过策略
  • 先创建元数据,再执行依赖它的 Flow 或数据任务

输出格式

完成时按以下顺序报告:

  1. 已创建或查询的元数据
  2. 已创建或更新的文件
  3. 关键架构 / 安全决策
  4. 权限 / 布局后续事项
  5. 后续部署步骤

建议格式:

Metadata task: <generate / query>
Items: <objects, fields, rules, layouts, permsets>
Files: <paths>
Notes: <naming, field types, security, dependencies>
Next step: <deploy, assign permset, or verify in Setup>

跨技能集成

需求委派给原因
部署元数据sf-deploy推出和验证
基于新架构构建 Flowsf-flow声明式自动化
基于新架构构建 Apexsf-apex根据元数据编写代码
创建后分析权限访问sf-permissions访问审计
部署后填充数据sf-data创建测试数据

参考索引

从这里开始
安全 / 评分 / 示例

评分指南

分数含义
108+强健、可用于生产的元数据
96–107优质元数据,仅有少量待审查事项
84–95可接受,但需谨慎验证
< 84修正前禁止部署

评论

支持 Markdown