es_delete_doc

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

The description discloses only one behavioral constraint: the readOnly block. It does not mention consequences (e.g., irreversible deletion), behavior on non-existent documents, permission needs, or response format. With no annotations, more detail is expected for a destructive operation.

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, directly to the point. The first sentence states the core function. The second adds a relevant behavioral note. No wasted words, but could be slightly more structured (e.g., listing conditions upfront).

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?

For a simple delete tool with no output schema, the description should explain what happens when the document is missing, whether the operation is idempotent, and if authorization is required. It lacks these details, leaving gaps for an agent to understand the full behavior.

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 67%, but the description adds no extra meaning beyond what is in the schema. The 'id' parameter lacks a description in both schema and tool description. The description could have clarified that 'id' is the document ID, but it did not.

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 states 'Delete a document by id,' which clearly specifies the action (delete) and the resource (document by id). It distinguishes from sibling tools like 'es_delete_by_query' and 'es_get_doc.' However, it doesn't explicitly mention the required 'index' parameter, which is part of the operation.

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 guidance on when to use this tool versus alternatives. It only mentions a condition ('Blocked when readOnly mode is enabled') but does not explain when to prefer this over 'es_delete_by_query' or other deletion methods.

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