Batch Create Entities

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

Annotations indicate readOnlyHint=false, confirming this is a write operation. The description adds that it creates multiple entities in batch, requires a 'type' key in each entity dict, and provides an example. This goes beyond annotations, though it does not detail atomicity or error behavior, which is acceptable given the example.

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 sentences plus an example, all front-loaded with the core purpose. No unnecessary words; 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?

The tool is batch creation of multiple entity types, which is moderately complex. With output schema present and sibling tools providing individual alternatives, the description adequately covers usage. It could mention error handling or transactionality, but the example and schema compensate for most gaps.

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% (parameter 'entities' has a description). The description adds value by requiring a 'type' key and providing a concrete example of valid entity definitions, clarifying the structure beyond the schema's generic description.

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 that the tool creates multiple entities in a single call for better performance. This distinguishes it from the many individual entity_create_* sibling tools (e.g., entity_create_line, entity_create_circle), making the purpose and scope explicit.

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 implies using this tool for batch creation to improve performance, but it does not explicitly state when to prefer it over individual entity_create_* tools or when not to use it. There is no mention of alternatives or exclusions, leaving the agent to infer usage context from sibling tools.

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