Bulk Insert Records (Bulk API 2.0)

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

Annotations already indicate mutating behavior (readOnlyHint=false, idempotentHint=false) and non-destructive nature. The description adds valuable context: asynchronous execution, returns a job ID for status tracking, and upsert behavior when externalIdField is provided. This goes beyond the structured annotations.

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 compact and front-loaded with the core purpose. The parameter list duplicates schema information but is brief and does not detract significantly. Slightly redundant, but efficient overall.

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?

The description covers the method, efficiency trade-off, async behavior, and job ID return. It does not explain tracking mechanics or error handling, but no output schema is expected. Given the moderate complexity and available annotations, it 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%, so the baseline is 3. The description repeats parameter names and adds brief clarifications (e.g., externalIdField 'performs upsert instead of insert'), but this largely mirrors the schema descriptions. No significant additional meaning is provided beyond the schema.

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 tool inserts multiple records asynchronously via Bulk API 2.0. It specifies the resource (records of an object type) and method (bulk insert), distinguishing it from individual REST calls by noting efficiency for large volumes.

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 description indicates use for large volumes ('More efficient than individual REST calls for large volumes') and notes the async nature with job ID tracking. It does not explicitly name alternative tools or exclusion criteria, but the guidance is clear for typical bulk-load scenarios.

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