Skip to main content
Glama
advancedcommunities

Salesforce MCP Server

sobject_describe

Read-onlyIdempotent

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

TableJSON Schema
NameRequiredDescriptionDefault
inputYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
labelYes
customYes
fieldsYes
keyPrefixYes
queryableYes
targetOrgYes
recordTypeInfosYes
childRelationshipsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.7.0

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description usefully adds the return format (JSON) and a workflow invariant (must precede query/manipulation), but does not mention auth requirements or org-selection behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in the first sentence, but the middle sentences are redundant — 'detailed metadata about a specific Salesforce SObject... comprehensive view of the SObject's structure' says the same thing twice. Still readable and appropriately sized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description need not explain return values, and annotations cover the safety profile. What remains — which SObject and which org — is left to the schema, which is adequate but not ideal.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description never mentions sObjectName or targetOrg, and schema description coverage is reported as 0%. For a tool whose only meaningful input is which SObject to describe, the description fails to compensate for the missing parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (describe) and resource (Salesforce SObject) and immediately scopes the payload ('fields, relationships, and other properties'), making it clearly distinct from siblings like sobject_list, list_metadata, and query_records.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit triggering conditions ('especially useful when writing Apex code or SOQL queries') and a strong prerequisite ('Always execute this tool before querying or manipulating records'). It does not name an alternative sibling (e.g., sobject_list or list_metadata), so the routing is implied rather than fully explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.