Delete a retrieval document

veryfront__delete_retrieval_document

Requires project.knowledge.write; API keys also need delete scope.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
expected_revisionstringNoDelete only this observed revision. A changed record is a conflict; a missing record is not_found. Delete the record before removing its chunks, as ragStore().removeDocument() does, so a concurrent refresh cannot publish through a still-visible record.
project_referencestringNoProject ID or slug. Minimum length: 1.
retrieval_document_idstringYesRetrieval document ID. Format: uuid.
confirmbooleanYesMust be true to delete the record.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__delete_retrieval_document",
    "arguments": {
      "retrieval_document_id": "00000000-0000-4000-8000-000000000000",
      "confirm": true
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
okbooleanYesValue: true.

Full schemas

json
{
  "type": "object",
  "properties": {
    "expected_revision": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "description": "Delete only this observed revision. A changed record is a conflict; a missing record is not_found. Delete the record before removing its chunks, as ragStore().removeDocument() does, so a concurrent refresh cannot publish through a still-visible record."
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug."
    },
    "retrieval_document_id": {
      "type": "string",
      "format": "uuid",
      "description": "Retrieval document ID."
    },
    "confirm": {
      "type": "boolean",
      "description": "Must be true to delete the record."
    }
  },
  "required": [
    "retrieval_document_id",
    "confirm"
  ],
  "additionalProperties": false,
  "description": "Arguments for the delete_retrieval_document tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the delete_retrieval_document tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}