Update Salesforce User

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

The description adds valuable behavioral context beyond the annotations: partial-update semantics ('Only fields you provide are updated') and the username-based lookup approach. It complements the idempotentHint and readOnlyHint=false without contradiction.

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 three sentences with the purpose front-loaded. It contains no redundant wording and quickly conveys the core operation, lookup method, and partial-update behavior.

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 write tool with moderate complexity, the description covers the essential aspects: what it updates, how users are identified, and the partial-update behavior. It lacks information about error conditions or permission requirements, but the annotations provide a safety profile, and no output schema is expected for update operations.

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 schema already provides 100% coverage of parameter descriptions, so the baseline is 3. The description's notable field list (firstName, lastName, etc.) aligns with additionalFields examples but doesn't introduce new meaning beyond what the schema's additionalFields example already conveys.

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 verb and resource: 'Updates an existing Salesforce user's properties via the REST API.' It lists specific updatable fields and explicitly distinguishes from creation by saying 'existing user' and by username lookup, setting it apart from generic record update tools.

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 the tool is for updating existing user records by username, which is clear context. However, it does not explicitly mention when not to use it or name alternatives like sf_update_record, but the intent is sufficiently clear from the resource-specific language.

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