salesforce_dml_records

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

With no annotations, the description carries the burden. It transparently discloses that update/delete require Id and upsert relies on an external ID field. It does not mention permissions or error scenarios, but the destructive nature is clear from 'Remove records'.

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?

Concise, well-structured bullet points with a clear opening sentence. Examples are helpful and no extraneous content exists.

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 DML tool with no output schema, the description is fairly complete—it covers all operations, prerequisites, and examples. However, it does not describe the return value or response format, which is a minor gap.

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 covers all parameters, but description adds meaningful context by explaining each operation's constraints (e.g., 'requires Id', 'based on external ID field'), going beyond the enumerated values.

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 performs data manipulation operations on Salesforce records, listing all supported operations (insert, update, delete, upsert) with brief explanations. It distinguishes itself from sibling tools like query/describe by focusing on write operations.

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?

Usage is implied through the operation list and examples (e.g., 'Insert new Accounts'), but there is no explicit guidance on when to use this tool versus read-only alternatives like salesforce_query_records. No exclusions are stated.

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