Skip to main content
Glama

ringkit_delete_knowledge_document

Destructive

Delete an uploaded knowledge document (by documentId); the receptionist stops using it on the next call. Reuse an idempotencyKey when retrying; without one, each call executes again.

Input Schema

NameRequiredDescriptionDefault
businessIdNoDefaults to the business of the API key in the Authorization header.
documentIdYesThe document's id (from list_knowledge_documents).
idempotencyKeyNoOptional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already supply destructiveHint=true and idempotentHint=false; the description goes beyond them by explaining the propagation delay and the retry model, and its 'without one, each call executes again' is consistent with idempotentHint=false rather than contradicting it. It stops short of stating that deletion is irreversible or what happens if documentId is already gone, which is the remaining behavioral gap for a destructive tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with no filler: the action and its effect come first, and the retry caveat follows. Every clause carries information an agent needs before calling a destructive endpoint.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-parameter destructive mutation with full schema coverage and rich annotations, the description covers action, effect timing, and retry safety, which is enough to call it correctly. Missing only failure-mode detail, such as behavior when the document does not exist, which is secondary given the annotated destructiveness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both the documentId source (list_knowledge_documents) and the idempotencyKey semantics are already documented in the schema. The description restates the idempotencyKey retry rule in condensed form, adding little beyond what the schema and annotations already establish, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Delete an uploaded knowledge document') plus the keying parameter (documentId), which cleanly separates it from get_knowledge_document, list_knowledge_documents, and patch_knowledge. It also names the observable outcome ('the receptionist stops using it on the next call'), so the agent knows what the deletion changes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The retry rule ('Reuse an idempotencyKey when retrying') is actionable operational guidance, and the timing note tells the agent the effect is deferred rather than immediate. However, it never addresses the choice among siblings — e.g. deleting a document versus patch_knowledge or set_knowledge_tier — so alternative selection is left to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources