salesforce_query

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

With no annotations, the description carries the full behavioral disclosure burden. It does this well by documenting the return structure, totalSize, done, records, and nextRecordsUrl, and by explaining include_deleted semantics and pagination state. It does not cover authentication, errors, or rate limits, but those are less critical for a read-only SOQL query tool.

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 well-structured with a clear one-line purpose followed by Args and Returns sections. Every sentence adds useful information, and the key purpose is front-loaded. No filler or redundant content.

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?

For a two-parameter query tool with an output schema, the description is largely complete: it covers both parameters and the return shape, including pagination hints. It could be more complete by explicitly directing the agent to salesforce_query_more when nextRecordsUrl is present, but the sibling list makes that inferable.

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 adequately documents soql with a concrete example and include_deleted with its default behavior. This adds meaning beyond the bare schema, though it could provide more detail on SOQL syntax constraints or response limits.

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 against Salesforce, using a specific verb and resource. It distinguishes itself from search/CRUD/describe siblings, but it does not explicitly differentiate from salesforce_query_all or salesforce_bulk_query, which also run SOQL queries.

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 implies this is the tool for running a SOQL query via the provided example. However, it gives no explicit guidance on when to choose this over salesforce_query_all, salesforce_bulk_query, or salesforce_query_more for pagination.

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