List files

veryfront__list_files

Requires project.files.read.

Access

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

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug
refstringNoContent selector: main, branch:<name-or-id>, release:<version>, or env:<name>. Omit for main.
branchstringNoBranch name or ID; alias for ref=branch:<value>.
branch_idstringNoLegacy branch name or ID alias. Conflicting selectors are rejected.
patternstringNoFile pattern filter (e.g., .tsx, pages/) Maximum length: 1024.
cursorstringNoOpaque page_info.next cursor from the preceding page. Returns a validation error if its file was deleted, renamed, or excluded from the current results.
limitintegerNoMax files to return (default: 100, max: 100) Minimum: 1. Maximum: 100.
sort_bystringNoSort by path or last update time (default updated_at). Default: "updated_at". Values: "path", "updated_at".
sort_orderstringNoSort direction (default desc). Tied update times break by path ascending. Default: "desc". Values: "asc", "desc".

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__list_files",
    "arguments": {}
  }
}

Result

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

FieldTypeRequiredDescription and constraints
dataobject[]YesPrimary result records returned by the tool.
page_infoobjectYesPagination cursor values for traversing the result set.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "ref": {
      "type": "string",
      "description": "Content selector: main, branch:<name-or-id>, release:<version>, or env:<name>. Omit for main."
    },
    "branch": {
      "type": "string",
      "description": "Branch name or ID; alias for ref=branch:<value>."
    },
    "branch_id": {
      "type": "string",
      "description": "Legacy branch name or ID alias. Conflicting selectors are rejected."
    },
    "pattern": {
      "type": "string",
      "maxLength": 1024,
      "description": "File pattern filter (e.g., *.tsx, pages/*)"
    },
    "cursor": {
      "type": "string",
      "description": "Opaque page_info.next cursor from the preceding page. Returns a validation error if its file was deleted, renamed, or excluded from the current results."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Max files to return (default: 100, max: 100)"
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "path",
        "updated_at"
      ],
      "description": "Sort by path or last update time (default updated_at).",
      "default": "updated_at"
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort direction (default desc). Tied update times break by path ascending.",
      "default": "desc"
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "binary": {
            "type": "object",
            "properties": {
              "content_hash": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "byte_size": {
                "type": "integer",
                "minimum": 0,
                "maximum": 8388608
              },
              "content_type": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200,
                "pattern": "^[\\x20-\\x7e]+$"
              }
            },
            "required": [
              "content_hash",
              "byte_size",
              "content_type"
            ],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "description": "File ID when supplied by the file store."
          },
          "version_id": {
            "type": "string",
            "description": "Current version ID when supplied by the file store."
          },
          "path": {
            "type": "string",
            "description": "Canonical file path within the selected branch."
          },
          "type": {
            "type": "string",
            "description": "File kind: page, function, component, or file."
          },
          "size": {
            "type": "number",
            "description": "Size of the file content encoded as UTF-8, in bytes."
          },
          "size_bytes": {
            "type": "number",
            "description": "Size of the file content encoded as UTF-8, in bytes. Same value as size."
          },
          "updated_at": {
            "type": "string",
            "description": "Last content update timestamp in ISO 8601 format."
          },
          "checksum": {
            "type": [
              "string",
              "null"
            ],
            "description": "SHA-256 content hash, or null when unavailable."
          }
        },
        "required": [
          "path",
          "type",
          "size",
          "size_bytes",
          "updated_at",
          "checksum"
        ],
        "additionalProperties": false
      },
      "description": "Primary result records returned by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "The supplied cursor, or null for the first request."
        },
        "first": {
          "type": [
            "string",
            "null"
          ],
          "description": "Always null; restart by omitting cursor."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opaque continuation cursor, or null when no more authorized files remain."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Always null; reverse pagination is unavailable."
        }
      },
      "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_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}