salesforce_search

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

With no annotations, the description carries the transparency burden. It discloses the return format ('List of matching records grouped by object type') and the non-mutating nature of a search, but it does not cover edge cases such as empty results, malformed SOSL, or permission requirements. This is adequate but not expansive.

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?

The description is short, well-organized into Args and Returns sections, and has no wasted words. The example is placed directly beside the parameter definition, making the invocation format easy to scan.

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 a single required parameter, an output schema, and a short description, the definition is nearly complete. It provides the call syntax, the return grouping, and an example. It lacks only explicit sibling routing and edge-case behavior, which are minor for this tool.

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 description coverage is 0%, so the description must fully explain the sosl parameter. It does so by defining it as a SOSL search string and providing a concrete, executable example with FIND and RETURNING clauses. This fully compensates for the schema gap.

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 opens with a specific verb and resource: 'Execute a SOSL full-text search.' It names the SOSL query type, which distinguishes it from the SOQL-based sibling tools such as salesforce_query, and it also states the return shape.

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 does not explicitly state when to choose this tool over salesforce_query or salesforce_query_all. However, 'SOSL full-text search' and the example clearly imply it is for cross-object text/keyword search, so usage is implied rather than explicit.

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