Skip to main content
Glama

Salesforce

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Sf Describe

sf_describe
Read-onlyIdempotent

Get schema details for a Salesforce object (e.g., 'Account'). Returns field names, types, relationships, and metadata. Use before querying to understand available fields.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
objectYesSObject type (e.g., "Account")

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoSObject type name
errorNoError code if describe failed
labelNoSObject display label
fieldsNoArray of field definitions
messageNoError message if describe failed

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "error": {
+      "description": "Error code if describe failed",
+      "type": "string"
+    },
+    "fields": {
+      "description": "Array of field definitions",
+      "items": {
+        "properties": {
+          "createable": {
+            "description": "Whether field can be created",
+            "type": "boolean"
+          },
+          "label": {
+            "description": "Field display label",
+            "type": "string"
+          },
+          "name": {
+            "description": "Field name",
+            "type": "string"
+          },
+          "referenceTo": {
+            "description": "Referenced object types for relationships",
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "required": {
+            "description": "Whether field is required",
+            "type": "boolean"
+          },
+          "type": {
+            "description": "Field data type",
+            "type": "string"
+          },
+          "updateable": {
+            "description": "Whether field can be updated",
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "label": {
+      "description": "SObject display label",
+      "type": "string"
+    },
+    "message": {
+      "description": "Error message if describe failed",
+      "type": "string"
+    },
+    "name": {
+      "description": "SObject type name",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "object": "Account"
+  },
+  {
+    "object": "Opportunity"
+  }
+]
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive nature. The description adds value by specifying the exact types of information returned (field names, types, relationships, metadata), which is beyond the annotations. No contradictions.

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 concise sentences: first explains purpose and output, second gives usage advice. No wasted words, front-loaded with core action.

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 single-parameter tool with high schema coverage and an output schema, the description fully covers what the tool does, its output, and when to use it. No missing critical information.

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 coverage is 100% (single parameter fully described). The description provides example values (Account, Opportunity) but adds minimal semantic depth beyond the schema. Baseline 3 is appropriate.

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 clearly states the tool retrieves schema details for a Salesforce object, specifying the verb (Get), resource (schema details), and returned data (field names, types, relationships, metadata). It distinguishes from sibling tools like sf_query or sf_get_record by focusing on schema discovery.

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 description advises using this tool before querying to understand available fields, providing clear context. While it doesn't explicitly exclude alternatives, the guidance is sufficient for an agent to decide when to invoke it.

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

All Salesforce toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources