generate_import_template

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

With no annotations provided, the description bears full responsibility. It discloses the tool creates a CSV-ready template and includes optional picklist values, but omits details about authentication requirements, rate limits, side effects (e.g., no data is modified), or return value structure beyond 'template'. Meets minimal expectations.

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?

Two sentences with the purpose front-loaded. No redundant information. Could optionally include a brief example or note about authentication but remains efficient.

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 presence of an output schema, the description adequately explains the tool's output. However, it lacks context on prerequisite setup (e.g., authentication, entity availability), error scenarios, or how the template is generated relative to specific parameters. Adequate for a straightforward generator but not fully comprehensive.

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 low (33%), and the description adds limited parameter-level meaning. It explains 'include_picklist_values' but does not clarify 'data_center', 'auth_user_id', 'auth_password', or 'include_fields'. The description's mention of 'field names, types, and key/required fields' helps contextualize the output but not the input parameters themselves.

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 it generates an import template for an SF entity, specifying it produces a CSV-ready template with field headers, types, and key/required fields. This distinguishes it from sibling generation tools like 'generate_mdf_import_template' which targets MDF objects, and from validation tools like 'validate_import_template'.

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 explicit guidance on when to use this tool versus alternatives such as 'generate_mdf_import_template' or other import-related tools. The description implies use for data preparation but does not specify prerequisites, excluded cases, or comparative advice.

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