swagger-petstore---openapi-3.0.updateUser

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

The annotations indicate destructive and idempotent behavior, and the description does not contradict them. However, it adds no additional behavioral details like the impact on existing data or authentication requirements, which are not covered by 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 with a single sentence, but it is under-specified. It conveys the basic action but omits key details, making it minimally useful despite its brevity.

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?

The description lacks context about the user resource, what fields can be updated, or any constraints. It does not address the output schema or response expectations, leaving the tool's full scope unclear.

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 has no properties, and the description does not mention any parameters (e.g., username, user fields). This leaves the agent without essential information about what inputs are required to perform the update.

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 the action (update) and resource (user), but it essentially restates the tool name without adding distinguishing details. It does not differentiate from other update tools like updatePet or updatePetWithForm, so it's clear but minimal.

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 provides no guidance on when to use this tool, such as prerequisites, typical scenarios, or alternatives. It lacks any context about updating an existing user versus creating a new one.

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