Skip to main content
Glama

salesforce_update_records

Update 1 to 200 existing Salesforce records in one approved call, all or none. Match by Id or External ID, change only listed fields, and reject unmatched or ambiguous keys.

Instructions

Change 1 to 200 existing records of one Salesforce object type in one approval, all or none. Each record is found by key_field: Id (default) or a field marked External ID. Only the fields listed change, records that already have those values are left alone, and a key that matches no record or several records refuses the whole call. Returns {object_type, updated, ids}. Use salesforce_update_record for one record by id and salesforce_search to find ids. Requires user approval.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
reasonYesOne sentence: why are you calling this tool right now?
recordsYesA JSON array of 1 to 200 objects, each holding key_field's value and the fields to change, such as [{"Id": "001...", "Phone": "+1 555 0100"}]. null clears a field.
key_fieldNoField that identifies each record: Id (the default), or the API name of a field marked External ID on this object, such as 'Customer_Number__c'. It is never changed itself.Id
object_typeYesAPI name of the Salesforce object, e.g. 'Account', 'Contact', 'Opportunity' or a custom object like 'Invoice__c'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv6.3.0

TDQS

A4.9/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing atomicity ('all or none', a key matching none or several refuses the whole call), no-op handling, partial-field update semantics, match resolution via key_field, and the return payload shape. These are the exact behaviors annotations (readOnly/idempotent/destructive) cannot express.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core behavior (batch update, all-or-none) in the first sentence, then conditions, then return shape, then sibling routing. Every clause carries information and nothing is repeated from the schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a batch mutation tool with no output schema, the description supplies the batch limit, atomicity, error/abort conditions, approval requirement, and the return keys ({object_type, updated, ids}). An agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so the baseline is 3, but the description adds meaning the schema does not: key_field defaults to Id or an External ID-marked field and 'is never changed itself', plus that only listed fields change and null clears a field. That is genuine semantic enrichment beyond the schema text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource with exact scope: change 1 to 200 existing records of one Salesforce object type. It differentiates itself from siblings by contrast ('Use salesforce_update_record for one record by id'), so an agent can pick the bulk vs. single variant without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes to alternatives: salesforce_update_record for a single record by id and salesforce_search to find ids. It also names the prerequisite ('Requires user approval') and the batch-size window, giving the agent clear conditions for when this tool applies.

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

Deploy Server

Other Tools