Skip to main content
Glama
Sign In
mcp-server-salesforce

mcp-server-salesforce

by julianboudara-code
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

salesforce_describe_object

Read-only

Retrieve full schema metadata for any Salesforce object, including all fields, relationships, and field properties. Use it to understand object structure before working with data.

Instructions

Get detailed schema metadata including all fields, relationships, and field properties of any Salesforce object. Examples: 'Account' shows all Account fields including custom fields; 'Case' shows all Case fields including relationships to Account, Contact etc.

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": {
      "objectName": "<objectName>"
    },
    "name": "salesforce_describe_object"
  }
}

Input Schema

NameRequiredDescriptionDefault
objectNameYesAPI name of the object (e.g., 'Account', 'Contact', 'Custom_Object__c')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.7

TDQS

A3.9/5.0
Behavior3/5

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

The readOnlyHint annotation already covers the read-only safety profile. The description adds useful context about the returned metadata content (fields, relationships, field properties) but does not disclose behavior such as response size, invalid object handling, or permissions. This is adequate but not rich.

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, front-loaded with the core purpose and followed by concrete examples. No filler or redundancy, and every sentence earns its place.

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

Completeness5/5

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

For a simple one-parameter, read-only describe tool, the description is complete: it states what the tool returns, gives valid object examples, and is backed by the readOnlyHint annotation. There is no output schema, but the description sufficiently conveys the expected metadata result.

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?

The schema already documents the single objectName parameter with examples at 100% coverage. The description reinforces the parameter with Account/Case examples but adds no new semantic details beyond what the schema provides, so the baseline of 3 applies.

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 uses a specific verb ('Get') and resource ('detailed schema metadata including all fields, relationships, and field properties'). The examples clarify that this is about object structure, not data records, which clearly distinguishes it from query/search/DML siblings.

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

Usage Guidelines3/5

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

The intended use is implied: call this when you need object schema metadata. However, the description does not explicitly say when to choose this over query_records, search_objects, or manage_object, and it provides no exclusions or alternative routing.

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

Deploy Server

Other Tools