Platform Metadata API Context Get
REQUIRED companion for Salesforce metadata generation — load this schema/API-context skill in the SAME turn as ANY metadata generator (if you load a generator, you ALSO load this). Use whenever you create, generate, edit, or author metadata or a *-meta.xml file (custom object, field, flow, and 604 Metadata API types): it gives authoritative schema, required flags, and XML structure so files deploy cleanly. Trigger on *-meta.xml, metadata schema, api context. DO NOT use for SOQL, DML, runtime sObject access, or Tooling API records.
- Skill ID
- forcedotcom/sf-skills/platform-metadata-api-context-get
- Publisher
- forcedotcom
- Repository
- sf-skills
- Installs
- 0
- Files
- 612
- Synced
- Sep 23, 2026
Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.
forcedotcom/sf-skills/platform-metadata-api-context-getInstalls these files- README.md
- SKILL.md
- assets/metadata_api/AIApplication.json
- assets/metadata_api/AIApplicationConfig.json
- assets/metadata_api/AIReplyRecommendationsSettings.json
- assets/metadata_api/AIScoringModelDefinition.json
- assets/metadata_api/AIUsecaseDefinition.json
- assets/metadata_api/AccountInsightsSettings.json
- assets/metadata_api/AccountIntelligenceSettings.json
- assets/metadata_api/AccountPlanObjMeasCalcDef.json
- assets/metadata_api/AccountPlanSettings.json
- assets/metadata_api/AccountRelationshipShareRule.json
- assets/metadata_api/AccountSettings.json
- assets/metadata_api/AccountingFieldMapping.json
- assets/metadata_api/AccountingModelConfig.json
- assets/metadata_api/AccountingSettings.json
- assets/metadata_api/ActionLinkGroupTemplate.json
- assets/metadata_api/ActionOverride.json
- assets/metadata_api/ActionPlanTemplate.json
- assets/metadata_api/ActionableListDefinition.json
- assets/metadata_api/ActionsSettings.json
- assets/metadata_api/ActivationPlatform.json
- assets/metadata_api/ActivationPlatformActvAttr.json
- assets/metadata_api/ActivationPlatformField.json
- assets/metadata_api/ActivitiesSettings.json
- assets/metadata_api/ActvPfrmDataConnectorS3.json
- assets/metadata_api/ActvPlatformAdncIdentifier.json
- assets/metadata_api/ActvPlatformFieldValue.json
- assets/metadata_api/AddressSettings.json
- assets/metadata_api/AdvAccountForecastSet.json
- assets/metadata_api/AffinityScoreDefinition.json
- assets/metadata_api/AgentPlatformSettings.json
- assets/metadata_api/AgentforceForDevelopersSettings.json
- assets/metadata_api/AiAuthoringBundle.json
- assets/metadata_api/AiEvaluationDefinition.json
- assets/metadata_api/AiPluginUtteranceDef.json
- assets/metadata_api/AllOrNoneHeader.json
- assets/metadata_api/AnalyticSnapshot.json
- assets/metadata_api/AnalyticsDashboard.json
- assets/metadata_api/AnalyticsSettings.json
- assets/metadata_api/AnalyticsVisualization.json
- assets/metadata_api/AnalyticsWorkspace.json
- assets/metadata_api/AnimationRule.json
- assets/metadata_api/ApexClass.json
- assets/metadata_api/ApexComponent.json
- assets/metadata_api/ApexEmailNotifications.json
- assets/metadata_api/ApexPage.json
- assets/metadata_api/ApexSettings.json
- assets/metadata_api/ApexTestSuite.json
- assets/metadata_api/ApexTrigger.json
- assets/metadata_api/AppAnalyticsSettings.json
- assets/metadata_api/AppExperienceSettings.json
- assets/metadata_api/AppFrameworkTemplateBundle.json
- assets/metadata_api/AppMenu.json
- assets/metadata_api/AppointmentAssignmentPolicy.json
- assets/metadata_api/AppointmentSchedulingPolicy.json
- assets/metadata_api/ApprovalProcess.json
- assets/metadata_api/ArticleType.json
- assets/metadata_api/ArticleType_CustomField.json
- assets/metadata_api/ArticleType_Layout.json
- assets/metadata_api/AssessmentQuestion.json
- assets/metadata_api/AssessmentQuestionSet.json
- assets/metadata_api/AssignmentRules.json
- assets/metadata_api/AssociationEngineSettings.json
- assets/metadata_api/AsyncResult.json
- assets/metadata_api/Audience.json
- assets/metadata_api/AuraDefinitionBundle.json
- assets/metadata_api/AuthProvider.json
- assets/metadata_api/AutoResponseRules.json
- assets/metadata_api/AutomatedContactsSettings.json
- assets/metadata_api/BaseSharingRule.json
- assets/metadata_api/BatchCalcJobDefinition.json
- assets/metadata_api/BatchProcessJobDefinition.json
- assets/metadata_api/BillingSettings.json
- assets/metadata_api/BlacklistedConsumer.json
- assets/metadata_api/Bot.json
- assets/metadata_api/BotBlock.json
- assets/metadata_api/BotSettings.json
- assets/metadata_api/BotTemplate.json
- assets/metadata_api/BotVersion.json
- assets/metadata_api/BranchManagementSettings.json
- assets/metadata_api/BrandingSet.json
- assets/metadata_api/BriefcaseDefinition.json
- assets/metadata_api/BusinessHoursSettings.json
- assets/metadata_api/BusinessProcess.json
- assets/metadata_api/BusinessProcessGroup.json
- assets/metadata_api/CMSConnectSource.json
- assets/metadata_api/CallCenter.json
- assets/metadata_api/CallCenterRoutingMap.json
- assets/metadata_api/CallCoachingMediaProvider.json
- assets/metadata_api/CallOptions.json
- assets/metadata_api/CampaignInfluenceModel.json
- assets/metadata_api/CampaignSettings.json
- assets/metadata_api/CancelDeployResult.json
- assets/metadata_api/CareBenefitVerifySettings.json
- assets/metadata_api/CareLimitType.json
- assets/metadata_api/CareProviderSearchConfig.json
- assets/metadata_api/CareRequestConfiguration.json
- assets/metadata_api/CareSystemFieldMapping.json
- assets/metadata_api/CaseSettings.json
- assets/metadata_api/CaseSubjectParticle.json
- assets/metadata_api/CatalogedApi.json
- assets/metadata_api/CatalogedApiArtifactVersionInfo.json
- assets/metadata_api/CatalogedApiVersion.json
- assets/metadata_api/Certificate.json
- assets/metadata_api/ChannelLayout.json
- assets/metadata_api/ChatterAnswersSettings.json
- assets/metadata_api/ChatterEmailsMDSettings.json
- assets/metadata_api/ChatterExtension.json
- assets/metadata_api/ChatterSettings.json
- assets/metadata_api/ChoiceList.json
- assets/metadata_api/ClaimFinancialSettings.json
- assets/metadata_api/ClauseCatgConfiguration.json
- assets/metadata_api/CleanDataService.json
- assets/metadata_api/CodeBuilderSettings.json
- assets/metadata_api/CollectionsDashboardSettings.json
- assets/metadata_api/CommerceSettings.json
- assets/metadata_api/CommunitiesSettings.json
- assets/metadata_api/Community.json
- assets/metadata_api/CommunityTemplateDefinition.json
- assets/metadata_api/CommunityThemeDefinition.json
- assets/metadata_api/CompactLayout.json
- assets/metadata_api/CompanySettings.json
- assets/metadata_api/ConnectedApp.json
- assets/metadata_api/ConnectedAppSettings.json
- assets/metadata_api/ContentAsset.json
- assets/metadata_api/ContentSettings.json
- assets/metadata_api/ContentTypeBundle.json
- assets/metadata_api/ContextDefinition.json
- assets/metadata_api/ContractSettings.json
- assets/metadata_api/ConvIntelligenceSignalRule.json
- assets/metadata_api/ConversationChannelDefinition.json
- assets/metadata_api/ConversationMessageDefinition.json
- assets/metadata_api/ConversationMessageDefinitionTranslation.json
- assets/metadata_api/ConversationVendorInfo.json
- assets/metadata_api/ConversationalIntelligenceSettings.json
- assets/metadata_api/CorsWhitelistOrigin.json
- assets/metadata_api/CriteriaBasedSharingRule.json
- assets/metadata_api/CspTrustedSite.json
- assets/metadata_api/CurrencySettings.json
- assets/metadata_api/CustomAddressFieldSettings.json
- assets/metadata_api/CustomApplication.json
- assets/metadata_api/CustomApplicationComponent.json
- assets/metadata_api/CustomFeedFilter.json
- assets/metadata_api/CustomField.json
- assets/metadata_api/CustomFieldDisplay.json
- assets/metadata_api/CustomHelpMenuSection.json
- assets/metadata_api/CustomIndex.json
- assets/metadata_api/CustomLabels.json
- assets/metadata_api/CustomMetadata.json
- assets/metadata_api/CustomNotificationType.json
- assets/metadata_api/CustomObject.json
- assets/metadata_api/CustomObjectTranslation.json
- assets/metadata_api/CustomPageWebLink.json
- assets/metadata_api/CustomPermission.json
- assets/metadata_api/CustomSite.json
- assets/metadata_api/CustomTab.json
- assets/metadata_api/CustomValue.json
- assets/metadata_api/CustomerDataPlatformSettings.json
- assets/metadata_api/Dashboard.json
- assets/metadata_api/DataCategoryGroup.json
- assets/metadata_api/DataConnector.json
- assets/metadata_api/DataConnectorIngestApi.json
- assets/metadata_api/DataConnectorS3.json
- assets/metadata_api/DataDotComSettings.json
- assets/metadata_api/DataImportManagementSettings.json
- assets/metadata_api/DataKitObjectDependency.json
- assets/metadata_api/DataKitObjectTemplate.json
- assets/metadata_api/DataObjectBuildOrgTemplate.json
- assets/metadata_api/DataObjectSearchIndexConf.json
- assets/metadata_api/DataPackageKitDefinition.json
- assets/metadata_api/DataPackageKitObject.json
- assets/metadata_api/DataSource.json
- assets/metadata_api/DataSourceBundleDefinition.json
- assets/metadata_api/DataSourceField.json
- assets/metadata_api/DataSourceObject.json
- assets/metadata_api/DataSourceTenant.json
- assets/metadata_api/DataSrcDataModelFieldMap.json
- assets/metadata_api/DataStreamDefinition.json
- assets/metadata_api/DataStreamTemplate.json
- assets/metadata_api/DataWeaveResource.json
- assets/metadata_api/DebuggingHeader.json
- assets/metadata_api/DecisionMatrixDefinition.json
- assets/metadata_api/DecisionTable.json
- assets/metadata_api/DecisionTableDatasetLink.json
- assets/metadata_api/DelegateGroup.json
- assets/metadata_api/DeleteResult.json
- assets/metadata_api/DeployResult.json
- assets/metadata_api/DeploymentSettings.json
- assets/metadata_api/DescribeMetadataResult.json
- assets/metadata_api/DescribeValueTypeResult.json
- assets/metadata_api/DevHubSettings.json
- assets/metadata_api/DgtAssetMgmtProvider.json
- assets/metadata_api/DgtAssetMgmtPrvdLghtCpnt.json
- assets/metadata_api/DigitalExperienceBundle.json
- assets/metadata_api/DigitalExperienceBundle_Marketing_Workspace_Bundle_and_Folders.json
- assets/metadata_api/DigitalExperienceBundle_Site_Workspace_Bundle_and_Folders.json
- assets/metadata_api/DigitalExperienceConfig.json
- assets/metadata_api/DisclosureDefinition.json
- assets/metadata_api/DisclosureDefinitionVersion.json
- assets/metadata_api/DisclosureType.json
- assets/metadata_api/DiscoveryAIModel.json
- assets/metadata_api/DiscoveryGoal.json
- assets/metadata_api/DiscoveryStory.json
- assets/metadata_api/Document.json
- assets/metadata_api/DocumentCategory.json
- assets/metadata_api/DocumentCategoryDocumentType.json
- assets/metadata_api/DocumentChecklistSettings.json
- assets/metadata_api/DocumentGenerationSetting.json
- assets/metadata_api/DocumentType.json
- assets/metadata_api/DuplicateRule.json
- assets/metadata_api/DynamicFormsSettings.json
- assets/metadata_api/EACSettings.json
- assets/metadata_api/EclairGeoData.json
- assets/metadata_api/EinsteinAISettings.json
- assets/metadata_api/EinsteinAgentSettings.json
- assets/metadata_api/EinsteinGptSettings.json
- assets/metadata_api/EmailAdministrationSettings.json
- assets/metadata_api/EmailAuthorizationSettings.json
- assets/metadata_api/EmailIntegrationSettings.json
- assets/metadata_api/EmailServicesFunction.json
- assets/metadata_api/EmailTemplate.json
- assets/metadata_api/EmailTemplateSettings.json
- assets/metadata_api/EmbeddedServiceBranding.json
- assets/metadata_api/EmbeddedServiceConfig.json
- assets/metadata_api/EmbeddedServiceFieldService.json
- assets/metadata_api/EmbeddedServiceFlowConfig.json
- assets/metadata_api/EmbeddedServiceLiveAgent.json
- assets/metadata_api/EmbeddedServiceMenuSettings.json
- assets/metadata_api/EmployeeUserSettings.json
- assets/metadata_api/EnablementMeasureDefinition.json
- assets/metadata_api/EnablementProgramDefinition.json
- assets/metadata_api/EnblProgramTaskSubCategory.json
- assets/metadata_api/EncryptionKeySettings.json
- assets/metadata_api/EnhancedNotesSettings.json
- assets/metadata_api/EntitlementProcess.json
- assets/metadata_api/EntitlementSettings.json
- assets/metadata_api/EntitlementTemplate.json
- assets/metadata_api/Error.json
- assets/metadata_api/EscalationRules.json
- assets/metadata_api/EventDelivery.json
- assets/metadata_api/EventRelayConfig.json
- assets/metadata_api/EventSettings.json
- assets/metadata_api/EventSubscription.json
- assets/metadata_api/ExperienceBundle.json
- assets/metadata_api/ExperienceBundleSettings.json
- assets/metadata_api/ExperiencePropertyTypeBundle.json
- assets/metadata_api/ExplainabilityMsgTemplate.json
- assets/metadata_api/ExpressionSetDefinition.json
- assets/metadata_api/ExpressionSetMessageToken.json
- assets/metadata_api/ExpressionSetObjectAlias.json
- assets/metadata_api/ExternalAIModel.json
- assets/metadata_api/ExternalAuthIdentityProvider.json
- assets/metadata_api/ExternalClientAppSettings.json
- assets/metadata_api/ExternalClientApplication.json
- assets/metadata_api/ExternalCredential.json
- assets/metadata_api/ExternalDataConnector.json
- assets/metadata_api/ExternalDataSource.json
- assets/metadata_api/ExternalDataTranObject.json
- assets/metadata_api/ExternalDataTransportFieldTemplate.json
- assets/metadata_api/ExternalDataTransportObjectTemplate.json
- assets/metadata_api/ExternalServiceRegistration.json
- assets/metadata_api/ExternalServicesSettings.json
- assets/metadata_api/ExtlClntAppCanvasSettings.json
- assets/metadata_api/ExtlClntAppConfigurablePolicies.json
- assets/metadata_api/ExtlClntAppGlobalOauthSettings.json
- assets/metadata_api/ExtlClntAppMobileConfigurablePolicies.json
- assets/metadata_api/ExtlClntAppMobileSettings.json
- assets/metadata_api/ExtlClntAppNotificationSettings.json
- assets/metadata_api/ExtlClntAppOauthConfigurablePolicies.json
- assets/metadata_api/ExtlClntAppOauthSettings.json
- assets/metadata_api/ExtlClntAppPushConfigurablePolicies.json
- assets/metadata_api/ExtlClntAppPushSettings.json
- assets/metadata_api/ExtlClntAppSamlConfigurablePolicies.json
- assets/metadata_api/FeatureParameterBoolean.json
- assets/metadata_api/FeatureParameterDate.json
- assets/metadata_api/FeatureParameterInteger.json
- assets/metadata_api/FieldMappingConfig.json
- assets/metadata_api/FieldRestrictionRule.json
- assets/metadata_api/FieldServiceSettings.json
- assets/metadata_api/FieldSet.json
- assets/metadata_api/FieldSrcTrgtRelationship.json
- assets/metadata_api/FileUploadAndDownloadSecuritySettings.json
- assets/metadata_api/FilesConnectSettings.json
- assets/metadata_api/FlexiPage.json
- assets/metadata_api/Flow.json
- assets/metadata_api/FlowCategory.json
- assets/metadata_api/FlowDefinition.json
- assets/metadata_api/FlowSettings.json
- assets/metadata_api/FlowTest.json
- assets/metadata_api/FlowValueMap.json
- assets/metadata_api/Folder.json
- assets/metadata_api/FolderShare.json
- assets/metadata_api/ForecastingFilter.json
- assets/metadata_api/ForecastingFilterCondition.json
- assets/metadata_api/ForecastingObjectListSettings.json
- assets/metadata_api/ForecastingSettings.json
- assets/metadata_api/ForecastingSourceDefinition.json
- assets/metadata_api/ForecastingType.json
- assets/metadata_api/ForecastingTypeSource.json
- assets/metadata_api/FuelType.json
- assets/metadata_api/FuelTypeSustnUom.json
- assets/metadata_api/FunctionReference.json
- assets/metadata_api/FundraisingConfig.json
- assets/metadata_api/GatewayProviderPaymentMethodType.json
- assets/metadata_api/GenAiFunction.json
- assets/metadata_api/GenAiPlanner.json
- assets/metadata_api/GenAiPlannerBundle.json
- assets/metadata_api/GenAiPlugin.json
- assets/metadata_api/GenAiPluginInstructionDef.json
- assets/metadata_api/GenAiPromptTemplate.json
- assets/metadata_api/GenAiPromptTemplateActv.json
- assets/metadata_api/GiftEntryGridTemplate.json
- assets/metadata_api/GlobalPicklist.json
- assets/metadata_api/GlobalPicklistValue.json
- assets/metadata_api/GlobalValueSet.json
- assets/metadata_api/GlobalValueSetTranslation.json
- assets/metadata_api/GoogleAppsSettings.json
- assets/metadata_api/Group.json
- assets/metadata_api/HighVelocitySalesSettings.json
- assets/metadata_api/HistoryRetentionPolicy.json
- assets/metadata_api/HomePageComponent.json
- assets/metadata_api/HomePageLayout.json
- assets/metadata_api/IPAddressRange.json
- assets/metadata_api/IdeasSettings.json
- assets/metadata_api/IdentityProviderSettings.json
- assets/metadata_api/IdentityVerificationProcDef.json
- assets/metadata_api/IdentityVerificationProcDtl.json
- assets/metadata_api/IdentityVerificationProcFld.json
- assets/metadata_api/IframeWhiteListUrlSettings.json
- assets/metadata_api/InboundCertificate.json
- assets/metadata_api/InboundNetworkConnection.json
- assets/metadata_api/IncidentMgmtSettings.json
- assets/metadata_api/Index.json
- assets/metadata_api/IndustriesEinsteinFeatureSettings.json
- assets/metadata_api/IndustriesLoyaltySettings.json
- assets/metadata_api/IndustriesPricingSettings.json
- assets/metadata_api/IndustriesRatingSettings.json
- assets/metadata_api/IndustriesSettings.json
- assets/metadata_api/IndustriesUnifiedInventorySettings.json
- assets/metadata_api/InsPlcyLimitConsumptionRule.json
- assets/metadata_api/InstalledPackage.json
- assets/metadata_api/IntegArtifactDef.json
- assets/metadata_api/IntegrationProviderDef.json
- assets/metadata_api/InterestTaggingSettings.json
- assets/metadata_api/InternalDataConnector.json
- assets/metadata_api/InvLatePymntRiskCalcSettings.json
- assets/metadata_api/InventorySettings.json
- assets/metadata_api/InvocableActionExtension.json
- assets/metadata_api/InvocableActionSettings.json
- assets/metadata_api/KeywordList.json
- assets/metadata_api/KnowledgeSettings.json
- assets/metadata_api/LanguageSettings.json
- assets/metadata_api/Layout.json
- assets/metadata_api/LeadConfigSettings.json
- assets/metadata_api/LeadConvertSettings.json
- assets/metadata_api/LearningItemType.json
- assets/metadata_api/Letterhead.json
- assets/metadata_api/LightningBolt.json
- assets/metadata_api/LightningComponentBundle.json
- assets/metadata_api/LightningExperienceSettings.json
- assets/metadata_api/LightningExperienceTheme.json
- assets/metadata_api/LightningMessageChannel.json
- assets/metadata_api/LightningOnboardingConfig.json
- assets/metadata_api/LightningTypeBundle.json
- assets/metadata_api/ListMetadataQuery.json
- assets/metadata_api/ListView.json
- assets/metadata_api/LiveAgentSettings.json
- assets/metadata_api/LiveChatAgentConfig.json
- assets/metadata_api/LiveChatButton.json
- assets/metadata_api/LiveChatDeployment.json
- assets/metadata_api/LiveChatSensitiveDataRule.json
- assets/metadata_api/LiveMessageSettings.json
- assets/metadata_api/LoyaltyProgramSetup.json
- assets/metadata_api/MLDataDefinition.json
- assets/metadata_api/MLPredictionDefinition.json
- assets/metadata_api/MacroSettings.json
- assets/metadata_api/MailMergeSettings.json
- assets/metadata_api/ManagedContentType.json
- assets/metadata_api/ManagedEventSubscription.json
- assets/metadata_api/ManagedTopics.json
- assets/metadata_api/MapAndLocationSettings.json
- assets/metadata_api/MarketSegmentDefinition.json
- assets/metadata_api/MarketingAppExtension.json
- assets/metadata_api/MatchingRule.json
- assets/metadata_api/MeetingsSettings.json
- assets/metadata_api/MessagingChannel.json
- assets/metadata_api/MetadataWithContent.json
- assets/metadata_api/Metadata_Type_Limits.json
- assets/metadata_api/MfgProgramTemplate.json
- assets/metadata_api/MfgServiceConsoleSettings.json
- assets/metadata_api/MilestoneType.json
- assets/metadata_api/MktCalcInsightObjectDef.json
- assets/metadata_api/MktDataTranObject.json
- assets/metadata_api/MlDomain.json
- assets/metadata_api/MobSecurityCertPinConfig.json
- assets/metadata_api/MobileApplicationDetail.json
- assets/metadata_api/MobileSecurityAssignment.json
- assets/metadata_api/MobileSecurityPolicy.json
- assets/metadata_api/MobileSettings.json
- assets/metadata_api/ModerationRule.json
- assets/metadata_api/MutingPermissionSet.json
- assets/metadata_api/MyDomainDiscoverableLogin.json
- assets/metadata_api/MyDomainSettings.json
- assets/metadata_api/NameSettings.json
- assets/metadata_api/NamedCredential.json
- assets/metadata_api/NamedFilter.json
- assets/metadata_api/NavigationMenu.json
- assets/metadata_api/Network.json
- assets/metadata_api/NetworkBranding.json
- assets/metadata_api/NotificationTypeConfig.json
- assets/metadata_api/NotificationsSettings.json
- assets/metadata_api/OauthCustomScope.json
- assets/metadata_api/OauthOidcSettings.json
- assets/metadata_api/OauthTokenExchangeHandler.json
- assets/metadata_api/ObjectHierarchyRelationship.json
- assets/metadata_api/ObjectLinkingSettings.json
- assets/metadata_api/ObjectSourceTargetMap.json
- assets/metadata_api/OcrSampleDocument.json
- assets/metadata_api/OcrTemplate.json
- assets/metadata_api/OmniChannelSettings.json
- assets/metadata_api/OmniExtTrackingDef.json
- assets/metadata_api/OmniInteractionAccessConfig.json
- assets/metadata_api/OmniInteractionConfig.json
- assets/metadata_api/OmniScript.json
- assets/metadata_api/OmniSupervisorConfig.json
- assets/metadata_api/OmniTrackingGroup.json
- assets/metadata_api/OnboardingDataObjectGroup.json
- assets/metadata_api/OpportunityInsightsSettings.json
- assets/metadata_api/OpportunityScoreSettings.json
- assets/metadata_api/OpportunitySettings.json
- assets/metadata_api/OrchestrationPlanCtxMapping.json
- assets/metadata_api/OrderManagementSettings.json
- assets/metadata_api/OrderSettings.json
- assets/metadata_api/OrgPreferenceSettings.json
- assets/metadata_api/OrgSettings.json
- assets/metadata_api/OutboundNetworkConnection.json
- assets/metadata_api/OwnerSharingRule.json
- assets/metadata_api/Package.json
- assets/metadata_api/PardotEinsteinSettings.json
- assets/metadata_api/PardotSettings.json
- assets/metadata_api/ParticipantRole.json
- assets/metadata_api/PartyDataModelSettings.json
- assets/metadata_api/PathAssistant.json
- assets/metadata_api/PathAssistantSettings.json
- assets/metadata_api/PaymentGatewayProvider.json
- assets/metadata_api/PaymentsSettings.json
- assets/metadata_api/PermissionSet.json
- assets/metadata_api/PermissionSetGroup.json
- assets/metadata_api/PermissionSetLicenseDefinition.json
- assets/metadata_api/PersonAccountOwnerPowerUser.json
- assets/metadata_api/Picklist.json
- assets/metadata_api/PicklistSettings.json
- assets/metadata_api/PipelineInspMetricConfig.json
- assets/metadata_api/PlatformCachePartition.json
- assets/metadata_api/PlatformEncryptionSettings.json
- assets/metadata_api/PlatformEventChannel.json
- assets/metadata_api/PlatformEventChannelMember.json
- assets/metadata_api/PlatformEventMigration.json
- assets/metadata_api/PlatformEventSettings.json
- assets/metadata_api/PlatformEventSubscriberConfig.json
- assets/metadata_api/Portal.json
- assets/metadata_api/PortalDelegablePermissionSet.json
- assets/metadata_api/PostTemplate.json
- assets/metadata_api/PredictionBuilderSettings.json
- assets/metadata_api/PresenceDeclineReason.json
- assets/metadata_api/PresenceUserConfig.json
- assets/metadata_api/PricingActionParameters.json
- assets/metadata_api/PricingRecipe.json
- assets/metadata_api/PrivacySettings.json
- assets/metadata_api/ProcessFlowMigration.json
- assets/metadata_api/ProductAttributeSet.json
- assets/metadata_api/ProductSettings.json
- assets/metadata_api/Profile.json
- assets/metadata_api/ProfileActionOverride.json
- assets/metadata_api/ProfilePasswordPolicy.json
- assets/metadata_api/ProfileSearchLayouts.json
- assets/metadata_api/ProfileSessionSetting.json
- assets/metadata_api/Prompt.json
- assets/metadata_api/PublicKeyCertificate.json
- assets/metadata_api/PublicKeyCertificateSet.json
- assets/metadata_api/Queue.json
- assets/metadata_api/QueueRoutingConfig.json
- assets/metadata_api/QuickAction.json
- assets/metadata_api/QuoteSettings.json
- assets/metadata_api/ReadResult.json
- assets/metadata_api/RealTimeEventSettings.json
- assets/metadata_api/RecommendationStrategy.json
- assets/metadata_api/RecordActionDeployment.json
- assets/metadata_api/RecordAggregationDefinition.json
- assets/metadata_api/RecordAlertCategory.json
- assets/metadata_api/RecordPageSettings.json
- assets/metadata_api/RecordType.json
- assets/metadata_api/RedirectWhitelistUrl.json
- assets/metadata_api/ReferencedDashboard.json
- assets/metadata_api/RegisteredExternalService.json
- assets/metadata_api/RelatedRecordAssocCriteria.json
- assets/metadata_api/RelationshipGraphDefinition.json
- assets/metadata_api/RemoteSiteSetting.json
- assets/metadata_api/Report.json
- assets/metadata_api/ReportType.json
- assets/metadata_api/RestrictionRule.json
- assets/metadata_api/RetailExecutionSettings.json
- assets/metadata_api/RetrievalSummaryDefinition.json
- assets/metadata_api/RetrieveRequest.json
- assets/metadata_api/RetrieveResult.json
- assets/metadata_api/Role.json
- assets/metadata_api/RoleOrTerritory.json
- assets/metadata_api/SalesAgreementSettings.json
- assets/metadata_api/SalesWorkQueueSettings.json
- assets/metadata_api/SamlSsoConfig.json
- assets/metadata_api/SandboxSettings.json
- assets/metadata_api/SaveResult.json
- assets/metadata_api/SchedulingObjective.json
- assets/metadata_api/SchedulingRule.json
- assets/metadata_api/SchemaSettings.json
- assets/metadata_api/Scontrol.json
- assets/metadata_api/SearchCustomization.json
- assets/metadata_api/SearchLayouts.json
- assets/metadata_api/SearchOrgWideObjectConfig.json
- assets/metadata_api/SearchSettings.json
- assets/metadata_api/SecuritySettings.json
- assets/metadata_api/ServiceAISetupDefinition.json
- assets/metadata_api/ServiceAISetupField.json
- assets/metadata_api/ServiceChannel.json
- assets/metadata_api/ServiceCloudVoiceSettings.json
- assets/metadata_api/ServicePresenceStatus.json
- assets/metadata_api/ServiceProcess.json
- assets/metadata_api/ServiceSetupAssistantSettings.json
- assets/metadata_api/SessionHeader.json
- assets/metadata_api/SharedTo.json
- assets/metadata_api/SharingBaseRule.json
- assets/metadata_api/SharingReason.json
- assets/metadata_api/SharingRecalculation.json
- assets/metadata_api/SharingRules.json
- assets/metadata_api/SharingSet.json
- assets/metadata_api/SharingSettings.json
- assets/metadata_api/SiteDotCom.json
- assets/metadata_api/SiteSettings.json
- assets/metadata_api/Skill.json
- assets/metadata_api/SocialCustomerServiceSettings.json
- assets/metadata_api/SocialProfileSettings.json
- assets/metadata_api/SourceTrackingSettings.json
- assets/metadata_api/StageAssignment.json
- assets/metadata_api/StageDefinition.json
- assets/metadata_api/StandardValueSet.json
- assets/metadata_api/StandardValueSetTranslation.json
- assets/metadata_api/StaticResource.json
- assets/metadata_api/StreamingAppDataConnector.json
- assets/metadata_api/SubscriptionManagementSettings.json
- assets/metadata_api/SurveySettings.json
- assets/metadata_api/SustainabilityUom.json
- assets/metadata_api/SustnUomConversion.json
- assets/metadata_api/SvcCatalogCategory.json
- assets/metadata_api/SvcCatalogFulfillmentFlow.json
- assets/metadata_api/SvcCatalogItemDef.json
- assets/metadata_api/SynonymDictionary.json
- assets/metadata_api/Tag.json
- assets/metadata_api/TagSet.json
- assets/metadata_api/Territory.json
- assets/metadata_api/Territory2.json
- assets/metadata_api/Territory2Model.json
- assets/metadata_api/Territory2Rule.json
- assets/metadata_api/Territory2Settings.json
- assets/metadata_api/Territory2Type.json
- assets/metadata_api/TimeSheetTemplate.json
- assets/metadata_api/TimelineObjectDefinition.json
- assets/metadata_api/TopicsForObjects.json
- assets/metadata_api/TrailheadSettings.json
- assets/metadata_api/TransactionSecurityPolicy.json
- assets/metadata_api/Translations.json
- assets/metadata_api/TrialOrgSettings.json
- assets/metadata_api/UIBundle.json
- assets/metadata_api/UIObjectRelationConfig.json
- assets/metadata_api/UiFormatSpecificationSet.json
- assets/metadata_api/UiPreviewMessageTabDef.json
- assets/metadata_api/UpsertResult.json
- assets/metadata_api/UserAccessPolicy.json
- assets/metadata_api/UserAuthCertificate.json
- assets/metadata_api/UserCriteria.json
- assets/metadata_api/UserEngagementSettings.json
- assets/metadata_api/UserInterfaceSettings.json
- assets/metadata_api/UserManagementSettings.json
- assets/metadata_api/UserProfileSearchScope.json
- assets/metadata_api/UserProvisioningConfig.json
- assets/metadata_api/ValidationRule.json
- assets/metadata_api/VirtualVisitConfig.json
- assets/metadata_api/VoiceSettings.json
- assets/metadata_api/WarrantyLifeCycleMgmtSettings.json
- assets/metadata_api/WaveAnalyticAssetCollection.json
- assets/metadata_api/WaveApplication.json
- assets/metadata_api/WaveComponent.json
- assets/metadata_api/WaveDashboard.json
- assets/metadata_api/WaveDataflow.json
- assets/metadata_api/WaveDataset.json
- assets/metadata_api/WaveLens.json
- assets/metadata_api/WaveRecipe.json
- assets/metadata_api/WaveTemplateBundle.json
- assets/metadata_api/WaveXmd.json
- assets/metadata_api/WebLink.json
- assets/metadata_api/WebStoreBundle.json
- assets/metadata_api/WebStoreTemplate.json
- assets/metadata_api/WorkDotComSettings.json
- assets/metadata_api/WorkSkillRouting.json
- assets/metadata_api/Workflow.json
- assets/metadata_api/WorkforceEngagementSettings.json
- examples/README.md
- examples/bash_section_loading.sh
- examples/javascript_section_loading.js
- examples/python_section_loading.py
- references/metadata_index_table.md
- references/usage_guide.md
What this skill tells the agent
Salesforce Metadata API Skill
This skill provides comprehensive documentation for all 604 Salesforce Metadata API types. Use this skill to create, understand, and modify Salesforce metadata XML files in your Salesforce DX projects.
Overview
The Salesforce Metadata API allows you to retrieve, deploy, create, update, or delete customizations for your org. This skill gives you access to detailed documentation for each metadata type, including:
- Field definitions and data types
- Required vs. optional fields
- WSDL schema definitions
- Sample XML structures
- File naming conventions
- Directory locations in Salesforce DX projects
How to Use This Skill
CRITICAL: Section-Specific Consumption
ALWAYS consume only the specific sections you need from JSON files, NOT entire files.
*CRITICAL: For `assets/metadata_api/.json files, always use jq or programmatic JSON parsing to extract only the specific sections you need.** Do not load these files whole via Read, cat, read_file, or any other tool that injects the complete file — they contain verbose WSDL segments and other sections that waste 60-80% of tokens. (Loading small files like this SKILL.md or the index table with Read` is fine; the rule applies specifically to the large metadata-type JSON files.)
Each JSON file contains multiple sections (fields, description, wsdl_segment, etc.). Most use cases only require 1-2 sections:
- For field definitions: Load only the
fieldssection - For understanding purpose: Load only the
descriptionsection - For XML examples: Load only the
declarative_metadata_sample_definitionsection - Skip by default:
wsdl_segment(verbose schema),file_information,directory_location
This reduces token consumption by 60-80% per file.
Quick Start
To get information about a specific metadata type:
- Section-specific (BEST): "Show me only the 'fields' section from CustomObject.json"
- Multiple sections: "Show me 'fields' and 'description' from Flow.json"
- Avoid loading entire files: Don't ask for "the CustomObject metadata type" - specify sections
Example Queries (Section-Specific)
Recommended:
- "Show me only the 'fields' section from CustomObject.json"
- "What fields are in the 'fields' section of Profile.json?"
- "Load the 'description' and 'fields' sections from Flow.json"
- "Give me just the 'declarative_metadata_sample_definition' from ApexClass.json"
Avoid:
- "Show me the CustomObject metadata type" (too broad - entire file)
- "Load CustomObject.json" (includes unnecessary WSDL and other sections)
JSON File Structure
Each metadata type is stored as a JSON file in assets/metadata_api/ with the following structure:
{
"sections": ["title", "description", "fields", "wsdl_segment", ...],
"title": "MetadataTypeName - Metadata API",
"description": "Plain-text description of the metadata type.",
"fields": {
"fieldName": {
"type": "string",
"description": "Field description",
"required": true
}
},
"file_information": ".object",
"directory_location": "objects",
"wsdl_segment": "<xsd:complexType>...</xsd:complexType>",
"declarative_metadata_sample_definition": [
{
"description": "Example description",
"code": "<?xml version=\"1.0\"?>\n<MetadataType>...\n</MetadataType>"
}
]
}Note: string values (title,description,file_information,directory_location,wsdl_segment) are stored as plain text — no markdown headers (#/##) or code fences.file_informationholds just the file suffix (e.g..object,.ai) anddirectory_locationjust the SFDX folder name (e.g.objects,aiApplications).
Available Sections
The sections array indicates which top-level keys are present in each file. Common sections include:
title: The metadata type name and headerdescription: What the metadata type representsfields: The type's own fields, with types and descriptionssub_types: (composite types only) a map of referenced sub-type name → that sub-type's fields, e.g.Flow→sub_types.FlowActionCallfile_information: File naming conventions and extensionsdirectory_location: Where files are stored in SFDX projectswsdl_segment: XML schema definition from the WSDLdeclarative_metadata_sample_definition: Example XML code
Some metadata types have additional sections specific to their functionality. See the Index Table for a complete breakdown.
More detail: background on why token optimization matters, worked usage examples, common workflows, a full section glossary, and versioning/support notes live in `references/usage_guide.md`. Load it with the Read tool only when needed.Token Optimization Strategies
CRITICAL: To minimize token usage and costs:
- Load only the specific metadata type(s) you need, not the full corpus
- Load only specific sections from each file, not entire files
Section-Specific Loading (BEST PRACTICE)
CRITICAL WARNING: DO NOT use the `read_file` tool (or any whole-file reading tool) on these JSON files!
read_file loads the entire file content into your context, defeating the purpose of section-specific consumption. You will waste 60-80% of your token budget loading unnecessary WSDL segments and verbose sections. (Using Read on small files such as this SKILL.md or the index table is fine — this rule is only about the large metadata-type JSON files.)
Approach: Programmatically parse the JSON file and extract ONLY the sections you need using code, not whole-file reading tools.
Working Examples Available:
We provide complete, working code examples in multiple languages:
- Python: `examples/python_section_loading.py` - Shows
json.load()with section extraction - JavaScript/Node.js: `examples/javascript_section_loading.js` - Shows
JSON.parse()with section extraction - Bash + jq: `examples/bash_section_loading.sh` - Shows
jqcommand-line JSON processing
See `examples/README.md` for complete documentation and usage instructions.
Quick Pattern (adapt to your language):
- Read the JSON file
- Parse it into a data structure
- Extract ONLY the sections you need (e.g.,
fields,description) - Ignore verbose sections (
wsdl_segment,declarative_metadata_sample_definition)
What NOT to Do
NEVER use the `read_file` tool on these JSON files:
read_file assets/metadata_api/CustomObject.json # Loads entire file into context!
read_file assets/metadata_api/Flow.json # Wastes 60-80% tokens!NEVER load all files:
read_file assets/metadata_api/*.json # This loads ~15MB of data!Token Impact:
- Section-specific: 50-200 tokens per metadata type
- Entire file: 500-2000 tokens per metadata type
- Savings: 60-80% per file
When to Load Multiple Types
- Related types: CustomObject + CustomField + ValidationRule
- Permission sets: Profile + PermissionSet + PermissionSetGroup
- UI components: Layout + CompactLayout + QuickAction
- Automation: Flow + WorkflowRule + ApexTrigger
When to Load Specific Sections (STRONGLY RECOMMENDED)
Many metadata types have large WSDL segments or extensive field lists. Always load only the specific sections you need from each JSON file rather than consuming the entire file:
- First, check available sections by reading just the
sectionsarray from the JSON - Extract only the sections you need (e.g.,
fieldsfor field definitions,descriptionfor overview) - Skip WSDL segments unless you specifically need schema validation
- Skip declarative_metadata_sample_definition unless you need complete XML examples
More from forcedotcom
Use this skill in a project
Open any RiverX project, search the Skills panel for forcedotcom/sf-skills/platform-metadata-api-context-get, and install it in one click.
