Skip to main content
Glama
Sign In
MCP Salesforce Connector

MCP Salesforce Connector

by smn2gnt
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

run_sosl_search

Execute SOSL searches in Salesforce with controlled results using RETURNING and LIMIT clauses to optimize data retrieval.

Instructions

Executes a SOSL search against Salesforce.

TOKEN OPTIMIZATION: Use RETURNING clause to limit fields and objects. Example: FIND {searchterm} RETURNING Account(Id, Name), Contact(Id, Name) LIMIT 10

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": {
      "search": "<search>"
    },
    "name": "run_sosl_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
formatNoOutput format: 'csv' (default), 'compact', 'json'csv
searchYesThe SOSL search to execute. Use RETURNING to specify fields and LIMIT for result count.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.15
    • addedInput schema / properties / format
      Added value: +{
+  "default": "csv",
+  "description": "Output format: 'csv' (default), 'compact', 'json'",
+  "enum": [
+    "csv",
+    "compact",
+    "json"
+  ],
+  "type": "string"
+}
    • changedInput schema / properties / search / description
      Previous value: -"The SOSL search to execute (e.g., 'FIND {John Smith} IN ALL FIELDS')"New value: +"The SOSL search to execute. Use RETURNING to specify fields and LIMIT for result count."
  2. First observedv1.0.0

TDQS

A3.5/5.0
Behavior2/5

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

No annotations are provided, so the description must convey behavioral traits. It states that the tool executes a search and includes a token optimization note, but does not disclose whether the operation is read-only (likely, but not explicit), any rate limits, or side effects. The description is insufficient for full behavioral understanding.

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?

The description is extremely concise: one sentence for the purpose, followed by a token optimization note and an example. It is front-loaded with the key action and avoids any fluff or repetition. Every sentence contributes value.

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

Completeness3/5

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

The description covers the basic function and parameter usage via example, but lacks details about return values (no output schema) and what the different formats (csv, compact, json) actually produce. Given the tool executes a search and outputs data, the absence of return format details is a gap, though the schema partially covers formats.

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%, so the baseline is 3. The description adds a token optimization emphasis and an example, but the schema already describes the 'search' parameter with RETURNING and LIMIT usage. The 'format' parameter is fully defined in the schema with enum. No meaningful additional semantics are provided 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 clearly states it executes a SOSL search against Salesforce, which is a specific verb-resource pair. It distinguishes itself from sibling tools like run_soql_query (which runs SOQL) by using the term SOSL, a distinct Salesforce query language for cross-object searches.

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 description provides an example and a token optimization tip, implying usage context (e.g., using RETURNING and LIMIT). However, it lacks explicit guidance on when to use SOSL versus other tools like run_soql_query, and does not mention when not to use this tool or alternatives.

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