veryfront__update_retrieval_documentAccess
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Can change resources.Arguments
| Field | Type | Required | Description and constraints |
|---|---|---|---|
title | string | Yes | Document title, at least one character. Minimum length: 1. |
source | string | No | Upstream source reference, such as a file path or URL. Defaults to "". |
type | string | No | Document type label. Defaults to "". |
metadata | object | No | Structured metadata stored with the record: an object of string keys to JSON values. |
expected_revision | string | Yes | The revision you read. A changed record is a conflict; a missing record is not_found. Title, source, type and metadata are replaced, and the response includes the new revision. |
project_reference | string | No | Project ID or slug. Minimum length: 1. |
retrieval_document_id | string | Yes | Retrieval document ID. Format: uuid. |
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.request.json
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__update_retrieval_document",
"arguments": {
"title": "example",
"expected_revision": "example",
"retrieval_document_id": "00000000-0000-4000-8000-000000000000"
}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError when handling a call.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id | string | Yes | Retrieval document ID. Format: uuid. |
revision | string | Yes | Opaque revision of this record. Send it as expected_revision to update or delete exactly this version. |
title | string | Yes | Document title. |
source | string | Yes | Upstream source reference, such as a file path or URL; empty when not set. |
type | string | Yes | Document type label; empty when not set. |
metadata | object | Yes | Structured metadata stored with the record: an object of string keys to JSON values. |
created_at | string | Yes | When the record was created (RFC 3339, UTC). Format: date-time. |
updated_at | string | Yes | When the record last changed (RFC 3339, UTC). Format: date-time. |
Full schemas
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "Document title, at least one character."
},
"source": {
"type": "string",
"description": "Upstream source reference, such as a file path or URL. Defaults to \"\"."
},
"type": {
"type": "string",
"description": "Document type label. Defaults to \"\"."
},
"metadata": {
"type": "object",
"additionalProperties": {
"description": "Additional structured values supplied to the tool."
},
"description": "Structured metadata stored with the record: an object of string keys to JSON values."
},
"expected_revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "The revision you read. A changed record is a conflict; a missing record is not_found. Title, source, type and metadata are replaced, and the response includes the new revision."
},
"project_reference": {
"type": "string",
"minLength": 1,
"description": "Project ID or slug."
},
"retrieval_document_id": {
"type": "string",
"format": "uuid",
"description": "Retrieval document ID."
}
},
"required": [
"title",
"expected_revision",
"retrieval_document_id"
],
"additionalProperties": false,
"description": "Arguments for the update_retrieval_document tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Retrieval document ID."
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Opaque revision of this record. Send it as expected_revision to update or delete exactly this version."
},
"title": {
"type": "string",
"description": "Document title."
},
"source": {
"type": "string",
"description": "Upstream source reference, such as a file path or URL; empty when not set."
},
"type": {
"type": "string",
"description": "Document type label; empty when not set."
},
"metadata": {
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Structured metadata stored with the record: an object of string keys to JSON values."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the record was created (RFC 3339, UTC)."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When the record last changed (RFC 3339, UTC)."
}
},
"required": [
"id",
"revision",
"title",
"source",
"type",
"metadata",
"created_at",
"updated_at"
],
"additionalProperties": false,
"description": "Structured result returned by the update_retrieval_document tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}