execute_soql_query

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It clearly describes the return format (dictionary with query, rows, row_count, columns) and important SOQL rules (no SELECT *, aggregate queries can't use LIMIT), which are critical behavioral constraints. It stops short of explicitly stating read-only semantics, but the nature of a SOQL query execution makes this reasonably inferable.

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 longer than strictly necessary but is well-structured with clear sections (Args, Returns, Important, Reference, Rules). Every section adds meaningful information, though the content could be tightened slightly without losing value.

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 the tool's complexity and the absence of annotations, the description covers essential aspects: return structure, critical rules, and a reference link. It also leverages the output schema for return details. It lacks explicit error-handling or permission requirements, but for a query execution tool, this is largely sufficient.

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?

The input schema only defines 'query' as a string with no description, leaving the description to fully compensate. The description explains the parameter with a concrete example ('SELECT Id, Name FROM Account LIMIT 10') and adds crucial constraints on valid query construction, thereby providing complete parameter semantics.

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's function: 'Execute a SOQL query against Salesforce.' This is a specific verb+resource pairing that distinguishes it from siblings like list_objects, describe_object, and get_soql_help, which serve 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 explicitly instructs users to consult get_soql_help() before constructing queries, which provides valuable context on when to use this tool versus learning/helper tools. However, it does not explicitly state when NOT to use this tool (e.g., for metadata exploration), leaving some ambiguity.

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