Update a Salesforce record

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

With no annotations, the description carries the behavioral burden. It does disclose meaningful traits: the operation is a PATCH (partial update), only provided fields are changed, and success returns 204 No Content. However, it omits permissions, error behavior, or side-effect details, so the transparency is adequate but incomplete.

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 with no filler. The core operation and endpoint are front-loaded, followed by the key usage rule and the success response, making every sentence earn its place.

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 simple update tool with a well-covered schema and no output schema, the description provides the essential return information (204) and the partial-update semantics. It is complete enough to invoke correctly, though error cases and permission requirements are not addressed.

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 already covers all 4 parameters at 100%, giving a baseline of 3. The description adds value beyond the schema by clarifying partial-update semantics: 'Pass only the fields you want to change' tells the agent the fields object is not a full replacement payload.

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 states a specific verb and resource: 'Update a single record' with the Salesforce REST endpoint PATCH /sobjects/{SObject}/{id}. The 'single record' qualifier clearly distinguishes it from bulk update siblings like sf_bulk_update_records.

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?

It provides clear context: update one record via PATCH, and 'Pass only the fields you want to change' gives practical invocation guidance. It does not explicitly name alternatives or when-not-to-use scenarios, but the single-record framing makes the intended scope evident relative to bulk tools.

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