pbs_user_create

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

Since no annotations are provided, the description fully covers behavioral traits: dry-run default, password redaction from plan/detail/audit ledger, synchronous execution without UPID, and the requirement for PROXIMO_PBS_* config. This gives the agent clear expectations.

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 extremely concise: three short paragraphs with front-loaded key info (MUTATION, dry-run), followed by critical redaction details, then usage guidance. Every sentence provides essential information without 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 mutation tool with 10 parameters, no annotations, and an output schema existing, the description covers return behavior (dict on confirm=True), sync nature, prerequisites, and redaction policy. It is fully self-contained and leaves no ambiguity about how to invoke the tool.

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 schema has 100% description coverage for all 10 parameters. The description adds value beyond the schema by explaining password redaction behavior, confirm's role in dry-run vs execution, and the userid format. However, much parameter meaning is already in the schema, so the description augments rather than compensates.

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 starts with 'MUTATION (MEDIUM): create a PBS user. Dry-run by default.' which clearly states the verb (create), resource (PBS user), and key behavior (dry-run). It also references sibling tools like pbs_user_update and pbs_user_delete, distinguishing this tool's purpose.

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 explicitly tells when to use alternatives: 'Use pbs_user_update to change it afterward, or pbs_user_delete to remove it.' It also states the prerequisite 'Needs PROXIMO_PBS_* config.' and explains the confirm parameter behavior (dry-run vs execute).

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