simple-salesforce-mcp

describe_object

Read-onlyIdempotent

Retrieve Salesforce object field definitions: API names, types, required flags, and picklist values. Use to prepare SOQL queries and create or update records accurately.

Instructions

Get a Salesforce object's fields: API names, types, required flags, and picklist values. Use before writing SOQL or creating/updating records.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "object_type": "<object_type>"
    },
    "name": "describe_object"
  }
}

Input Schema

Name	Required	Description	Default
`detail`	No	basic (default): fields with type/required/picklists. full: adds child relationships, record types, per-field help text and defaults.
`object_type`	Yes	Object API name, e.g. Account or My_Object__c.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 4, 2026

TDQS

A4/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is covered. The description adds useful output context (field metadata, picklist values) but does not disclose additional behavioral traits such as auth requirements, rate limits, or edge-case behavior.

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

Conciseness5/5

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

Two sentences, zero filler. The core action and output are front-loaded, and the usage guidance follows immediately. Every word earns its place.

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?

For a simple read-only metadata tool with only two parameters and no output schema, the description covers the essential behavior and use case. It could be slightly richer by noting the basic vs. full detail distinction, but the schema already documents that.

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

Parameters3/5

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

Schema description coverage is 100%, so both object_type and detail are already well documented. The description does not need to compensate, and it adds no significant parameter-level detail beyond the schema.

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?

The description names a specific verb ('Get') and resource ('a Salesforce object's fields') and even enumerates what is returned: API names, types, required flags, and picklist values. It clearly distinguishes this metadata-description tool from record-focused siblings like get_record or run_soql_query.

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?

The second sentence gives explicit guidance: 'Use before writing SOQL or creating/updating records.' This tells an agent when the tool is appropriate, though it does not explicitly name alternatives or state when not to use it.

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

Deploy Server