Update users

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

The description discloses the two main behaviors (admin modification or removal) but lacks details on idempotency, side effects, required permissions, or partial update semantics. With no annotations, this is insufficient.

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?

Single sentence with no wasted words. Front-loaded with purpose and concise enough to be quickly parsed.

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 mutation tool with three parameters and no output schema, the description covers the essential actions. Missing details about simultaneous updates or return values are minor given the tool's simplicity.

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 description adds meaning to the isAdmin parameter by linking it to 'grant/revoke admin,' which the schema lacks. For deleted, the schema already explains removal. The id parameter is adequately described in schema. This compensates for the 67% schema coverage.

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 updates an employee by granting/revoking admin or removing them. It uses specific verbs and resource identification, and distinguishes from siblings like create or list by emphasizing update and removal actions.

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?

No guidance on when to use this tool versus alternatives (e.g., yougile_users_create for new users, yougile_users_get for reading). The description does not mention prerequisites or context for usage.

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