salesforce_query

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 include_deleted behavior, which is useful, but does not mention other behavioral aspects such as read-only nature, result limits, or error handling.

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 two short sentences, front-loaded with the main action. It is efficient and to the point with no filler.

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?

An output schema exists, so return values need not be explained. However, the description is very minimal and does not mention pagination or when to use salesforce_query_more, which is a notable gap given the sibling tool list. It covers the basic action but lacks depth for a complex querying 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 compensate. It adds clarity for include_deleted, but leaves org and query semantics unexplained beyond their parameter names. The query parameter is required and intuitively understandable, but no syntax or example is provided.

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 states the tool executes a SOQL query, using a specific verb and resource. This distinguishes it from sibling tools like salesforce_search or salesforce_get_record, which have different purposes.

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 gives clear context for using SOQL queries but does not explicitly mention alternatives or when not to use it. It could have benefited from a note about salesforce_query_more for pagination, but the core usage is immediately evident.

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