Delete KB Documents

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the deletion nature is known. The description adds no further behavioral context such as permanence, permissions, or effects on related data, but it does not contradict the 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?

A single sentence that immediately states the action, resource, and mechanism. Every word earns its place, and the structure is front-loaded for quick parsing.

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 operation with complete schema and useful annotations, the description is adequate. It could add a note about irreversibility or return behavior, but the essential context is covered by the structured data.

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%, with both rag_id and docs fully described. The description mentions 'document ids' but adds no additional meaning beyond what the schema already provides, landing at the baseline for complete schema coverage.

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 a specific verb ('Delete'), a resource ('documents from a knowledge base'), and the method ('by their document ids'). This clearly distinguishes it from the sibling tool lyzr_kb_delete_docs_by_filter, which deletes by filter rather than specific IDs.

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 gives no explicit guidance on when to use this tool versus alternatives like lyzr_kb_delete_docs_by_filter or lyzr_kb_delete. Usage is implied by the operation itself but not articulated, leaving the agent to infer context.

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