Synchronize a user federation provider

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

Annotations do not provide behavioral hints beyond mutability. Description only says 'trigger a user sync', omitting details on side effects, concurrency, asynchronicity, or whether it modifies provider state. With no annotations, this is insufficient.

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?

One compact sentence that communicates the core action and key parameter choice. No unnecessary words, and it is front-loaded.

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?

Missing critical context: no mention of return value (e.g., job ID, success message), whether sync is synchronous or asynchronous, or potential impact on system. For a mutation tool with no output schema, more detail is needed.

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?

Description adds context for 'mode' by listing 'full or changed', which complements the enum in the schema. However, it does not explain the 'id' parameter or provide details on the meaning of the modes, and schema coverage is 0%.

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?

Description clearly states the action: 'Trigger a user sync from a federation provider' with specification of sync type (full or changed). It differentiates from sibling tools like keycloak_federation_get and keycloak_federation_list which are read-only.

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?

No guidance on when to use this tool versus alternatives, such as keycloak_federation_get. Does not explain when to use 'full' vs 'changed' modes, nor mention prerequisites like provider existence.

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