generate_purge_file

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

Discloses fetching records, returning CSV content ready for SF Import purge mode, and warns to review before deletion. With no annotations, description carries disclosure burden; it's clear but could explicitly state no actual deletion occurs.

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 concise sentences plus a warning, front-loaded with purpose. No redundant information; every sentence adds value.

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?

Covers purpose and high-level behavior. Has output schema so return details not needed. Lacks context on authentication parameters and filter syntax; adequate 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 coverage is 40% (only entity and filter_expr described). Description mentions filter but does not clarify data_center, auth_user_id, or auth_password parameters, failing to compensate for missing schema descriptions.

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?

Clearly states 'Generate a purge/delete file for SF import', specifying verb and resource. Distinguishes from siblings like execute_upsert (upsert) and query_odata (query) by focusing on deletion file generation.

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?

Implies usage for deletion via SF Import, with a warning to review records. Lacks explicit guidance on when to use vs alternatives (e.g., execute_upsert for upserts) or when not to use.

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