pbs_realm_ldap_update

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

With no annotations, the description carries full burden. It discloses mutation severity, dry-run default, password redaction, synchronous execution, no UPID, and config requirement. This is substantial behavioral context.

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?

Four dense sentences that front-load the purpose and add essential behavioral details. Every sentence earns its place with zero wasted words.

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?

Given an output schema exists, the description adequately covers the two-phase workflow, mutation semantics, and config requirements. It could explicitly state that only provided fields are updated, but the schema's nullable default pattern implies this.

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 baseline is 3. The description adds value for key parameters (confirm, password) but does not enhance understanding of other 19 parameters beyond what the schema already provides.

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 'update an LDAP realm's config', a specific verb+resource. It mentions a sibling tool (pbs_realm_ldap_create) for password redaction reference, but does not explicitly distinguish from pbs_realm_ldap_delete or other update tools.

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 implies usage for updating LDAP realm config and explains the dry-run/confirm workflow, but does not state when not to use this tool or mention alternatives like pbs_realm_ldap_create/delete/get.

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