Synchronize a user federation provider

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

Describes behavioral traits beyond annotations: clarifies it is a write operation, not destructive, not idempotent, and that each call re-runs the sync with potentially different import counts. No contradiction with annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false).

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 concise sentences, each serving a purpose: purpose, behavioral traits, usage order, and return type. No redundant phrasing; front-loaded with the main action.

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 tool with 2 parameters and no output schema, the description covers essential context: purpose, use case, parameter details, and return value. Lacks some detail about error handling (e.g., if id is invalid), but is largely complete.

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%, but the description adds meaningful context: explains the id field as a Keycloak component UUID and where to obtain it, and describes the mode parameter's options and default behavior. This goes beyond the schema definitions.

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 the verb 'triggers a user synchronization' and identifies the resource as 'user federation provider' (e.g., LDAP). It explicitly distinguishes from sibling tools keycloak_federation_list and keycloak_federation_get by advising the agent to use them first to confirm the provider id.

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?

Provides explicit when-to-use guidance: use federation_list/get first to confirm provider id, then run this to refresh users. Also explains the mode parameter and its default behavior, and notes that the operation is not idempotent, which affects when to call it.

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