patchLicenseAssignments

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

Annotations already carry idempotentHint=trueasia, so the idempotency statement is somewhat redundant. However, the description adds important behavioral context beyond annotations: the dry_run preview semantics, including that the preview is returned as an error-flagged result on tools with typed output schemas. It also discloses the environment limitation. No contradiction with 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 longer than the simplest examples, but each sentence earns its place: purpose, unsupported environments, cardinality, alternative, idempotency, dry-run tip, and preview caveat. It is well-segmented with labels like 'Cardinality', 'Effect', and 'Tip', making it scannable despite its length. Slightly verbose but not wasteful.

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 the tool's complexity (nested request body, dry_run flag, idempotent behavior, sibling alternatives, no output schema), the description covers all needed context: what it does, when to use it instead of the singular tool, unsupported platforms, idempotent semantics, and dry_run explaination. The schema already documents parameters and body structure, so nothing an agent needs to call this safely is missing.

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 baseline is 3. The description adds a tactical tip about using dry_run first, but it does not materially expand on the parameter meanings already given in the schema (e.g., dry_run's redaction behavior and the requestBody structure are fully covered there). Thus it stays at the baseline without compensating for gaps.

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 a specific verb and resource: 'Updates the License Assignments of multiple users.' It clarifies cardinality ('targets the full collection or a batch') and explicitly differentiates from the sibling tool for a single item ('For a single item by ID, use patchLicenseAssignment instead'). This leaves no ambiguity about what this tool does or how it differs from the singular variant.

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 explicit usage guidance: it names the alternative for single-item cases ('use patchLicenseAssignment instead'), states a limitation ('Not supported by cloud-based Polarion X'), and recommends a workflow ('set dry_run: true first'). This is exactly what an agent needs to decide when to invoke this tool vs. the singular sibling.

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