salesforce-metadata-api-reference

Document 604 Salesforce Metadata API types with XML structures and schema details.

Updated Jun 1, 2026
One-click install
npx skills add https://github.com/Collabalist/SFDC --skill salesforce-metadata-api-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: salesforce-metadata-api-reference
Source: https://github.com/Collabalist/SFDC/tree/main/.agents/skills/getting-metadata-api-context
Command: npx skills add https://github.com/Collabalist/SFDC --skill salesforce-metadata-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, python3, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill simplifies access to comprehensive documentation and tools for working with Salesforce Metadata API, streamlining customization and development processes.

Core Features & Use Cases

  • Complete Documentation: Access detailed information for all 604 Salesforce Metadata API types, including field definitions, XML structures, and schema details.
  • Metadata Creation and Management: Facilitate the creation, modification, and understanding of metadata files like .object-meta.xml and .flow-meta.xml.
  • Use Case: When working on a Salesforce project, use this Skill to quickly look up the fields, XML format, and schema information for a specific metadata type like CustomObject or Flow.

Quick Start

Use the salesforce-metadata-api-reference skill to retrieve the XML structure of the CustomObject metadata type.

Frequently Asked Questions about salesforce-metadata-api-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find the XML structure for a specific Salesforce metadata type?

To find the XML structure for a Salesforce metadata type, use this reference to retrieve detailed schema information, field definitions, and XML formats for any of the 604 supported types. It provides exact structures needed for files like .object-meta.xml.

What is the Salesforce Metadata API used for in SFDX development?

The Salesforce Metadata API is used for metadata customization and development, allowing developers to create, modify, and manage metadata files. This Skill provides comprehensive documentation covering 604 metadata types for SFDX projects.

Do I need to know Salesforce DX to use the Salesforce Metadata API reference?

Yes, you need existing knowledge of the Salesforce Metadata API and Salesforce DX. The reference provides detailed schema and XML structures for 604 metadata types, assuming you understand SFDX development processes.

How do I look up field definitions for a CustomObject in the Metadata API?

To look up field definitions for a CustomObject, query the reference for the CustomObject metadata type. It returns comprehensive schema details, field definitions, and the required XML structure for your metadata files.

Does the Salesforce Metadata API reference cover Flow metadata files?

Yes, the Salesforce Metadata API reference covers Flow metadata files, providing the specific field definitions, XML structures, and schema details needed to create and modify .flow-meta.xml files.

What dependencies are required to explore Salesforce metadata schemas?

To explore Salesforce metadata schemas, you need jq and python3 installed in your environment. These dependencies support the scripts that retrieve and parse the 604 metadata type definitions and XML structures.