Get file

veryfront__get_file

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 (defaults to the current project)
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.
file_pathstringNoPath of the file. Send file_path or path, not two different values.
pathstringNoFile path (e.g., pages/index.mdx). Read files matched by search_knowledge before answering Knowledge Q&A questions.

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__get_file",
    "arguments": {
      "file_path": "notes.txt"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
binaryobjectNo
pathstringYesCanonical file path within the selected branch.
typestringYesFile kind: page, function, component, or file.
contentstringYesFull textual file content.
sizenumberYesSize of the file content encoded as UTF-8, in bytes.
version_idstringNoResolved content version ID when supplied by the file store.
checksumstring or nullYesSHA-256 content hash, or null when unavailable.
idstringNoFile ID when supplied by the file store.
size_bytesnumberYesSize of the file content encoded as UTF-8, in bytes. Same value as size.
updated_atstringYesLast content update timestamp in ISO 8601 format.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug (defaults to the current project)"
    },
    "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."
    },
    "file_path": {
      "type": "string",
      "description": "Path of the file. Send file_path or path, not two different values."
    },
    "path": {
      "type": "string",
      "description": "File path (e.g., pages/index.mdx). Read files matched by search_knowledge before answering Knowledge Q&A questions."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the get_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "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
    },
    "path": {
      "type": "string",
      "description": "Canonical file path within the selected branch."
    },
    "type": {
      "type": "string",
      "description": "File kind: page, function, component, or file."
    },
    "content": {
      "type": "string",
      "description": "Full textual file content."
    },
    "size": {
      "type": "number",
      "description": "Size of the file content encoded as UTF-8, in bytes."
    },
    "version_id": {
      "type": "string",
      "description": "Resolved content version ID when supplied by the file store."
    },
    "checksum": {
      "type": [
        "string",
        "null"
      ],
      "description": "SHA-256 content hash, or null when unavailable."
    },
    "id": {
      "type": "string",
      "description": "File ID when supplied by the file store."
    },
    "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."
    }
  },
  "required": [
    "path",
    "type",
    "content",
    "size",
    "checksum",
    "size_bytes",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}