Reset a user’s password

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

Annotations only provide idempotentHint=false. The description adds valuable behavioral context: the tool sends an email, does not set or return a password, and requires a confirmation token for the follow-up call. This goes beyond the annotation and clarifies side effects.

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?

Three short sentences, each adding a distinct and necessary piece of information: what the tool does, what it does not do, and what is required. No filler or redundancy.

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 two-step token-based reset flow, the description covers the core behavior, side effect (email), and token requirement well. The schema handles parameter details. It does not state the return value explicitly, but the schema's confirm_token description already implies a token is returned when omitted.

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 100%, with both user_id and confirm_token already documented in the schema. The description reinforces the token workflow but does not add meaningful parameter-level meaning beyond what the schema provides, so the baseline of 3 is appropriate.

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 a specific verb and resource ('Starts Wiki.js' own password reset for a local account') and explicitly clarifies that no password is chosen or returned, which distinguishes it from direct password-setting tools like update_user. The behavior is immediately clear.

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 explains the email-link reset flow and the need for a confirmation token, giving a clear sense of when to use this tool. It does not explicitly name alternatives or exclusions, but the context is strong enough to guide selection.

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