update_user

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

No annotations are provided, so the description must disclose behavioral traits. It only says 'Update', which implies mutation, but lacks details on permission requirements, whether partial updates are supported, reversibility, or any side effects. This is a significant gap for a mutation tool.

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 a single sentence with no filler, directly stating the action and target. It is front-loaded and appropriately sized for the information it conveys.

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?

An output schema exists, which reduces the need to describe return values. However, this is a mutation tool with minimal description; it does not address prerequisites, permissions, effect on existing user settings, or potential side effects. The output schema only partially compensates for the lack of contextual detail.

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 description coverage is 0%, so the description must compensate. It names the fields (site_role, full_name, email) but these are already present as parameter names in the schema, adding little value. It does not explain the semantics of user_id (e.g., whether it's an ID or email) or provide any detail beyond the schema's own enum description for site_role.

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's purpose with a specific verb ('update'), resource ('user'), and enumerates the mutable attributes (site role, full name, email). This distinguishes it from sibling tools like create_user, get_user, and remove_user.

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 usage — when you need to update a user's site role, full name, or email — but it does not explicitly state when to use this over alternatives or mention any exclusions or preconditions. No references to alternative tools are provided.

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