Skip to main content
List files in a project branch.

Tool details

FieldValue
Namelist_files
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)"
    },
    "pattern": {
      "type": "string",
      "description": "File pattern filter (e.g., *.tsx, pages/*)"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Max files to return (default: 100, max: 100)"
    }
  },
  "required": [
    "project_reference"
  ],
  "additionalProperties": false,
  "description": "Input schema for the list_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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."
          },
          "size": {
            "type": "number",
            "description": "The size associated with this tool result."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp in ISO 8601 format."
          },
          "checksum": {
            "type": [
              "string",
              "null"
            ],
            "description": "The checksum associated with this tool result."
          }
        },
        "required": [
          "path",
          "type",
          "size",
          "updated_at",
          "checksum"
        ],
        "additionalProperties": false,
        "description": "One data item associated with this tool result."
      },
      "description": "Primary result records returned by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": [
            "string",
            "null"
          ],
          "description": "The first associated with this tool result."
        },
        "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_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}