List external files

veryfront__list_external_files

Requires project.integrations.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. Requires project.integrations.read through the caller's own personal provider connection.
providerstringYesStorage provider accessed through the caller's own personal connection. A shared project connection is not used. Values: "onedrive", "sharepoint", "drive".
folder_idstringNoFolder ID from a previous listing, or "root". Omit for the provider root. SharePoint sites are "sp-site:{siteId}". Minimum length: 1. Maximum length: 1024.
pathstringNoOlder folder path selector; use folder_id. Not together with folder_id.
querystringNoSearch text. Searches below folder_id when given; SharePoint needs a site or folder to search. Minimum length: 1. Maximum length: 256.
cursorstringNopage_info.next (or the "Pass cursor" value) from the previous page. Opaque cursors retain the original folder/path and query when omitted; explicit selectors must match the original listing.
limitintegerNoMaximum number of entries to request (max 200) Minimum: 1. Maximum: 200.

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__list_external_files",
    "arguments": {
      "provider": "onedrive"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
messagestringYesContains the formatted file records as text. If another page exists, the final line includes Pass cursor: "<value>". Copy that quoted value into the next request cursor; no continuation line means there is no next page.
dataobject[]YesThe items on this page, in provider order.
page_infoobjectYesPagination: pass page_info.next as cursor for the next page.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug. Requires project.integrations.read through the caller's own personal provider connection."
    },
    "provider": {
      "type": "string",
      "enum": [
        "onedrive",
        "sharepoint",
        "drive"
      ],
      "description": "Storage provider accessed through the caller's own personal connection. A shared project connection is not used."
    },
    "folder_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024,
      "description": "Folder ID from a previous listing, or \"root\". Omit for the provider root. SharePoint sites are \"sp-site:{siteId}\"."
    },
    "path": {
      "type": "string",
      "description": "Older folder path selector; use folder_id. Not together with folder_id."
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "description": "Search text. Searches below folder_id when given; SharePoint needs a site or folder to search."
    },
    "cursor": {
      "type": "string",
      "description": "page_info.next (or the \"Pass cursor\" value) from the previous page. Opaque cursors retain the original folder/path and query when omitted; explicit selectors must match the original listing."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "Maximum number of entries to request (max 200)"
    }
  },
  "required": [
    "provider"
  ],
  "additionalProperties": false,
  "description": "Arguments for the list_external_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Contains the formatted file records as text. If another page exists, the final line includes Pass cursor: \"<value>\". Copy that quoted value into the next request cursor; no continuation line means there is no next page."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1024,
            "description": "Unique identifier for the returned record."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "path": {
            "type": "string"
          },
          "mime_type": {
            "type": "string",
            "minLength": 1
          },
          "size": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "size_bytes": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "is_folder": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "enum": [
              "file",
              "folder"
            ]
          },
          "modified_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null",
                "description": "The modified at returned by the tool."
              }
            ]
          },
          "thumbnail": {
            "type": "string"
          },
          "provider": {
            "type": "string",
            "enum": [
              "onedrive",
              "sharepoint",
              "drive"
            ]
          },
          "parent_id": {
            "anyOf": [
              {
                "$ref": "#/properties/data/items/properties/id"
              },
              {
                "type": "null",
                "description": "The parent id returned by the tool."
              }
            ]
          },
          "etag": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 1024,
                "pattern": "^(?:\\*|(?:W\\/)?\"[\\x21\\x23-\\x7e]*\"(?:[ \\t]*,[ \\t]*(?:W\\/)?\"[\\x21\\x23-\\x7e]*\")*|[!#$%&'*+.^_`|~0-9A-Za-z-]+)$"
              },
              {
                "type": "null",
                "description": "The etag returned by the tool."
              }
            ]
          },
          "thumbnail_url": {
            "anyOf": [
              {
                "$ref": "#/properties/data/items/properties/thumbnail",
                "description": "The thumbnail url returned by the tool."
              },
              {
                "type": "null",
                "description": "The thumbnail url returned by the tool."
              }
            ]
          },
          "web_url": {
            "anyOf": [
              {
                "$ref": "#/properties/data/items/properties/thumbnail",
                "description": "The web url returned by the tool."
              },
              {
                "type": "null",
                "description": "The web url returned by the tool."
              }
            ]
          }
        },
        "required": [
          "id",
          "name",
          "path",
          "mime_type",
          "size",
          "size_bytes",
          "is_folder",
          "kind",
          "modified_at",
          "provider",
          "parent_id",
          "etag",
          "thumbnail_url",
          "web_url"
        ],
        "additionalProperties": false
      },
      "description": "The items on this page, in provider order."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "anyOf": [
            {
              "type": "string",
              "description": "Cursor that refers to the current page."
            },
            {
              "type": "null",
              "description": "Cursor that refers to the current page."
            }
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "anyOf": [
            {
              "$ref": "#/properties/page_info/properties/self/anyOf/0",
              "description": "Cursor for the next page when pagination is available."
            },
            {
              "type": "null",
              "description": "Cursor for the next page when pagination is available."
            }
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": "null",
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination: pass page_info.next as cursor for the next page."
    }
  },
  "required": [
    "message",
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_external_files tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}