Add or Modify User in Collection

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

Annotations already declare idempotentHint=true, destructiveHint=false, and readOnlyHint=false. The description adds no further behavioral context, such as side effects of sending email (sendMail parameter) or what happens when a user already exists. The description provides minimal transparency 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 a single sentence, only 15 words, and immediately conveys the tool's purpose. It is front-loaded and contains no unnecessary information, making it highly efficient for an AI agent to parse.

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 is minimal for a tool with 5 parameters, no output schema, and many siblings. It does not mention return values, error scenarios, or optional parameters like sendMail. Given the lack of output schema and the tool's complexity, the description is insufficiently complete.

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%, so the parameter descriptions already exist in the schema. The tool description adds no additional meaning about parameters, such as explanation of role values or clarification of the alternative userid parameter. Baseline 3 is appropriate as the schema carries the burden.

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 adds a user to a collection or modifies their role if they already exist. This distinguishes it from sibling tools like transkribus_coll_user_remove (removes user) and transkribus_coll_user_update_role (likely only updates role), as it covers both add and modify actions in one tool.

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 versus its siblings, such as transkribus_coll_user_add or transkribus_coll_user_update_role. It does not mention prerequisites, when not to use it, or how to choose it over alternatives.

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