delete_document

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

With no annotations, the description must disclose behavioral traits. It only states the action without mentioning side effects (e.g., permanence, version conflicts), prerequisites, or the nature of the operation beyond deletion. The explanation of the cluster parameter is helpful but insufficient for full transparency.

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 concise with a single-sentence purpose and a bullet-like argument list. It front-loads the main action and avoids unnecessary details, making it efficient for an agent to parse.

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 does not need to detail return values. However, it lacks information about error conditions, idempotency, or prerequisites (e.g., index existence). For a delete operation among similar sibling tools, this leaves some contextual 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 description coverage is 0%, so the description compensates by providing brief explanations for each parameter: index ('Name of the index'), id ('Document ID'), and cluster ('Optional cluster name. Uses the default cluster if omitted.'). This adds meaning beyond the schema, though the descriptions are minimal.

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 'Delete a document by ID,' specifying the verb 'delete' and the resource 'document by ID'. This effectively distinguishes the tool from sibling tools like delete_index or delete_by_query.

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 provides no explicit guidance on when to use this tool versus alternatives such as delete_by_query or delete_alias. Usage context is only implied by the action 'delete a document by ID,' but no when-not-to-use or prerequisite information is present.

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