veryfront__list_retrieval_documentsAccess
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Read-only.Arguments
| Field | Type | Required | Description and constraints |
|---|---|---|---|
limit | integer | No | Records per page, 1 to 100; default 20. Minimum: 1. Maximum: 100. |
cursor | string | No | Opaque page_info.next from the previous page. A cursor this list did not issue is invalid_input. Minimum length: 1. Maximum length: 2048. |
project_reference | string | No | Project ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated. Minimum length: 1. |
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__list_retrieval_documents",
"arguments": {}
}
}
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 |
|---|---|---|---|
data | object[] | Yes | Retrieval document records behind ragStore(), oldest first with ID as tie-breaker. Read the ID and current revision before updating or deleting. Follow the next cursor until null to read every record. |
page_info | object | Yes | Pagination cursor values for traversing the result set. |
Full schemas
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Records per page, 1 to 100; default 20."
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"description": "Opaque page_info.next from the previous page. A cursor this list did not issue is invalid_input."
},
"project_reference": {
"type": "string",
"minLength": 1,
"description": "Project ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated."
}
},
"additionalProperties": false,
"description": "Arguments for the list_retrieval_documents tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"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": "Retrieval document records behind ragStore(), oldest first with ID as tie-breaker. Read the ID and current revision before updating or deleting. Follow the next cursor until null to read every record."
},
"page_info": {
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor that refers to the current page."
},
"first": {
"type": "null"
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page when pagination is available."
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page when pagination is available."
}
},
"required": [
"self",
"first",
"next",
"prev"
],
"additionalProperties": false,
"description": "Pagination cursor values for traversing the result set."
}
},
"required": [
"data",
"page_info"
],
"additionalProperties": false,
"description": "Structured result returned by the list_retrieval_documents tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}