Salesforce SOSL Search

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

Annotations declare readOnlyHint, idempotentHint true and destructiveHint false, which the description does not contradict. The description adds behavioral context by explaining the SOSL search mechanism, return format (searchRecords), and that results are grouped by object type. It could mention any limitations like pagination or SOQL differences, but the additional context is valuable.

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

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

Description is well-structured: starts with purpose, then usage guidance, followed by example queries, and finally parameter descriptions. Every sentence adds value; no redundancy or filler. Front-loaded with key information.

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

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

Given no output schema, the description adequately covers return values (JSON with searchRecords or Markdown formatted by object type). Both parameters are fully explained with examples. The tool's complexity (SOSL search) is well-addressed for an AI agent to use correctly.

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

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

Schema coverage is 100%, so baseline is 3. The description adds significant meaning beyond the schema: it explains the SOSL parameter with multiple examples, clarifies that the query must be valid SOSL, and details the response_format parameter including default value and output behavior. This greatly aids correct invocation.

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

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

The description clearly specifies 'Search across multiple Salesforce objects using SOSL', providing a specific verb and resource. It distinguishes from sibling tools like salesforce_query (likely for single object SOQL queries) by emphasizing multi-object and full-text search capability.

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

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

The description explicitly states 'Use SOSL when you want to search across multiple object types at once or do full-text search', providing clear when-to-use guidance. It implicitly contrasts with salesforce_query for single object queries, and the example queries further clarify usage scenarios.

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