> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List sandbox files

> List sandbox files.

`veryfront__list_sandbox_files`

Requires project.sandboxes.manage.

## Access

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

**Call type:** Read-only.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `sandbox_id` | `string` | Yes | Sandbox UUID, as returned by createSandbox. Format: `uuid`. |
| `path` | `string` | Yes | Directory path inside the sandbox. Minimum length: `1`. |
| `cursor` | `string` | No | Cursor from the previous `page_info`.next. Omit it to read the first page. |
| `limit` | `integer` | No | Maximum entries to return. Defaults to 20 and is capped at 100. Default: `20`. Minimum: `1`. Maximum: `100`. |

## 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](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_sandbox_files",
    "arguments": {
      "sandbox_id": "00000000-0000-4000-8000-000000000000",
      "path": "example"
    }
  }
}
```

## Result

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

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `data` | `object[]` | Yes | Primary result records returned by the tool. |
| `page_info` | `object` | Yes | Pagination cursor values for traversing the result set. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "sandbox_id": {
      "type": "string",
      "format": "uuid",
      "description": "Sandbox UUID, as returned by createSandbox."
    },
    "path": {
      "type": "string",
      "minLength": 1,
      "description": "Directory path inside the sandbox."
    },
    "cursor": {
      "type": "string",
      "description": "Cursor from the previous page_info.next. Omit it to read the first page."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Maximum entries to return. Defaults to 20 and is capped at 100.",
      "default": 20
    }
  },
  "required": [
    "sandbox_id",
    "path"
  ],
  "additionalProperties": false,
  "description": "Arguments for the list_sandbox_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "file",
              "directory",
              "symlink",
              "other"
            ]
          },
          "size_bytes": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0
              },
              {
                "type": "null",
                "description": "The size bytes returned by the tool."
              }
            ]
          }
        },
        "required": [
          "path",
          "type",
          "size_bytes"
        ],
        "additionalProperties": false
      },
      "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": "null"
        },
        "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_sandbox_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__list_sandbox_files` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.