Get release file

veryfront__get_release_file

Requires project.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
release_referencestringYesRelease ID, latest, or a version specifier such as "1.2.3" or "1.2". Minimum length: 1.
file_referencestringYesProject-relative file path, for example pages/index.mdx, or file ID. Minimum length: 1.
include_server_functionsbooleanNoSet to false to read server-function source only as an editor. Omit to use the rule every MCP file read uses, which lets a project-scoped service token with file read access read it.
fieldsstringNoResponse projection, for example (id,path,size). Accepted as on REST; the structured output keeps every required field.

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_release_file",
    "arguments": {
      "release_reference": "example",
      "file_reference": "example"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
idstringYesUnique identifier for the returned record.
version_idstringYes
pathstringYes
contentstringYesSource content or body returned by the tool.
binaryobjectNo
sizenumberYes
typestringYesValues: "page", "function", "component", "file".
updated_atstringYesLast update timestamp in ISO 8601 format.
release_idstringYesRelease identifier associated with this result.
release_versionstring or nullYesRelease version string associated with this result.
_linksobjectNo

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "release_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Release ID, `latest`, or a version specifier such as \"1.2.3\" or \"1.2\"."
    },
    "file_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project-relative file path, for example pages/index.mdx, or file ID."
    },
    "include_server_functions": {
      "type": "boolean",
      "description": "Set to false to read server-function source only as an editor. Omit to use the rule every MCP file read uses, which lets a project-scoped service token with file read access read it."
    },
    "fields": {
      "type": "string",
      "pattern": "^!?\\([^)]*\\)$",
      "description": "Response projection, for example (id,path,size). Accepted as on REST; the structured output keeps every required field."
    }
  },
  "required": [
    "release_reference",
    "file_reference"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_release_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "version_id": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "content": {
      "type": "string",
      "description": "Source content or body returned by the tool."
    },
    "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
    },
    "size": {
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "page",
        "function",
        "component",
        "file"
      ]
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp in ISO 8601 format."
    },
    "release_id": {
      "type": "string",
      "description": "Release identifier associated with this result."
    },
    "release_version": {
      "type": [
        "string",
        "null"
      ],
      "description": "Release version string associated with this result."
    },
    "_links": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values associated with this result."
      }
    }
  },
  "required": [
    "id",
    "version_id",
    "path",
    "content",
    "size",
    "type",
    "updated_at",
    "release_id",
    "release_version"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_release_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}