sobject_describe
Retrieve detailed metadata for a Salesforce SObject, including fields, relationships, and properties. Use it before writing SOQL or Apex to confirm correct field names and types.
Instructions
Describe a Salesforce SObject. This command retrieves detailed metadata about a specific Salesforce SObject, including its fields, relationships, and other properties. The results are returned in JSON format, providing a comprehensive view of the SObject's structure. Use this command to understand the schema of a specific SObject, which is especially useful when writing Apex code or SOQL queries that interact with that SObject. Always execute this tool before querying or manipulating records in the SObject to ensure you have the correct field names and types.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| label | Yes | ||
| custom | Yes | ||
| fields | Yes | ||
| keyPrefix | Yes | ||
| queryable | Yes | ||
| targetOrg | Yes | ||
| recordTypeInfos | Yes | ||
| childRelationships | Yes |