patchLicenseAssignment

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

Annotations already declare idempotentHint=true and destructiveHint=false, so restating idempotency adds little, but the description contributes real new context: it flags that Polarion X cloud does not support this endpoint and explains what dry_run actually returns (preview as plain text, plus structured content when an output schema exists). It does not clarify the effect of omitting nested relationship fields such as addOnSlots.

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?

Short and front-loaded, with labeled clauses (Cardinality, Effect, Tip) that make it scannable. The idempotency sentence partly repeats the annotation, and the closing sentence about executor return channels is a bit meta, but nothing is seriously padded.

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 a nested requestBody and no output schema, it covers the essentials: single-item scope, cloud incompatibility, idempotency, and a safe validation path. What it leaves out is patch semantics for the nested relationship fields (e.g., whether omitting addOnSlots clears assignments) and any error/permission behavior.

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 coverage is 100%, so the parameters are already documented. The description still adds process meaning by framing userId as single-item targeting and by advising dry_run be set first, extending the schema's own dry_run definition into a workflow recommendation.

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?

Opens with a specific verb+resource ("Updates a user's License Assignment") and immediately scopes it to a single item by ID. It names the sibling `patchLicenseAssignments` as the batch/collection alternative, so an agent can distinguish the two without opening either schema.

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?

Explicit when-to-use (single item by ID), when-not-to-use (full collection or batch → `patchLicenseAssignments`), and a recommended first step (`dry_run: true` to validate before sending). All the routing decisions are stated rather than inferred.

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