provider_sync_ldap

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false and destructiveHint=false, so the safety profile is covered. The description adds meaningful context in 'Begins the ... task', signalling a kickoff/async operation that does not itself wait for completion, but it says nothing about what gets modified, side effects on existing users, or how to observe sync progress.

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?

Three short lines, front-loaded with the purpose before the mechanics. The raw 'POST /cloudapi/1.0.0/ldap/sync' line adds little for an agent and duplicates the annotation title, but nothing is 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?

A fire-and-forget mutation with no parameters and no output schema needs only a little context, and the description supplies the core of it. However, it omits how to verify the sync result or whether the operation is asynchronous, and no sibling tool obviously provides LDAP sync status.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline of 4 applies.

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?

States a specific verb and resource: 'Synchronize LDAP users/settings' plus 'Begins the LDAP sync task'. This clearly separates it from read-only LDAP siblings such as provider_search_ldap_users, provider_search_ldap_groups and provider_test_ldap, though no sibling is named explicitly.

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 phrase 'Begins the LDAP sync task' implies this is the trigger action to run once LDAP settings are configured, but there is no statement of when to prefer it over provider_test_ldap or provider_update_org_ldap_settings, and no preconditions (e.g., LDAP must already be configured).

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