Skip to main content
Read file content from a project branch.

Tool details

FieldValue
Nameget_file
GroupFiles

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "branch_id": {
      "type": "string",
      "description": "Branch ID (omit for main branch)"
    },
    "path": {
      "type": "string",
      "description": "File path (e.g., pages/index.mdx)"
    }
  },
  "required": [
    "project_reference",
    "path"
  ],
  "additionalProperties": false,
  "description": "Input schema for the get_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The path associated with this tool result."
    },
    "type": {
      "type": "string",
      "description": "The type associated with this tool result."
    },
    "content": {
      "type": "string",
      "description": "Source content or body returned by the tool."
    },
    "size": {
      "type": "number",
      "description": "The size associated with this tool result."
    },
    "checksum": {
      "type": [
        "string",
        "null"
      ],
      "description": "The checksum associated with this tool result."
    }
  },
  "required": [
    "path",
    "type",
    "content",
    "size",
    "checksum"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}