Delete Knowledge Base Article

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

With no annotations, the description carries the full behavioral burden. It usefully discloses that deletion cascades to the Knowledge Overlay Graph index, a non-obvious side effect, but omits irreversibility, permission requirements, and whether a confirmation or soft-delete occurs.

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 short sentences, front-loaded with the action and immediately followed by the scope of the effect. No filler text.

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 two-param destructive tool with full schema coverage and an output schema, the description is nearly sufficient, especially since it explains the index side effect. It stops short of confirming irreversibility or auth needs, which matters for a delete operation with no annotations.

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 100%, documenting both note_id (UUID of the article) and workspace_name (e.g. 't-oncall'), so the schema does the heavy lifting. The description adds no parameter-level meaning beyond that, which is the expected baseline here.

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) and resource (Knowledge Base article) and adds the scope of removal via the Knowledge Overlay Graph index. Siblings like create_knowledge_base_article and update_knowledge_base_article are implicitly distinguished by verb, though the description never names them explicitly.

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?

It states what deletion does but gives no when-to-use guidance, no prerequisites, and no pointer to alternatives (e.g. use update_knowledge_base_article to modify rather than delete). The agent must infer usage from the name alone.

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