Freeze or Unfreeze User

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

Annotations already indicate non-readonly, non-destructive, idempotent. The description adds context by explaining the effect (cannot log in, license retained) and the use case, which goes beyond the annotations.

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 concise, using a few sentences to convey purpose, behavioral context, and usage. The parameter notes are redundant with schema but not excessive. It's well-structured.

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 boolean toggle, the description provides sufficient context: action, effect, use case, and parameters. No output schema is needed, and the behavior is clear.

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 both parameters with descriptions. The description adds a note that the username parameter can accept either a username or userId, which is additional information beyond the schema's 'Salesforce username.' However, this could be slightly ambiguous, and the freeze parameter is already well described.

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 freezes or unfreezes a Salesforce user account, a specific action on a specific resource. It also distinguishes this from deactivation by noting license retention, which sets it apart from other user-management 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?

It explicitly states a use case: 'Useful for temporarily blocking access without losing data ownership.' It also contrasts with deactivation, providing guidance on when not to use it.

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