sync_directory

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

No annotations are provided, so the description must carry the behavioral disclosure burden. 'Sync' implies a mutation that could overwrite or delete existing members, but the description doesn't explain whether it replaces the full directory, merges, or handles deletions. It also doesn't mention permissions, reversibility, or return behavior.

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 two short sentences with the purpose first and the parameter hint second. It is efficient with no fluff, though the brevity sacrifices critical operational details.

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 sync operation, the description is incomplete. It lacks critical context such as whether existing members not in the provided list are removed, whether the operation is atomic, and what happens on failure. The lack of an output schema and any behavioral disclosure makes this insufficient for an agent to predict outcomes.

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 schema has zero description coverage for the only parameter 'data'. The description adds 'List of members mapping to the onboarding structure', giving some meaning about the expected content, but it doesn't specify the exact shape or fields of the onboarding structure. This partially compensates for the schema gap but remains vague.

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 'Sync members of the organization', providing a specific verb (sync) and resource (members). It distinguishes from siblings like list_members by implying a write/update operation, but it doesn't explicitly contrast with other member-related tools.

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 is given on when to use this tool versus alternatives such as list_members or create_vendor. The description does not state prerequisites, exclusions, or scenarios where syncing is appropriate.

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