Read external file

veryfront__read_external_file

Returns UTF-8 text for text files or base64-encoded bytes with is_binary: true for other MIME types. Works with documents, spreadsheets, CSV, and text files. Use list_external_files first to find file IDs.

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
`project_reference`	`string`	No	Project ID or slug
`provider`	`string`	Yes	External storage provider: “onedrive”, “sharepoint” or “drive” (Google Drive). Values: `"onedrive"`, `"sharepoint"`, `"drive"`.
`file_id`	`string`	Yes	File ID from `list_external_files`

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.

request.json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__read_external_file",
    "arguments": {
      "provider": "onedrive",
      "file_id": "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
`message`	`string`	Yes	Agent-readable status message or rendered content for the external storage operation.
`content`	`string`	Yes	File content. UTF-8 text for a text MIME type, base64-encoded bytes when `is_binary` is true.
`is_binary`	`boolean`	Yes	True when the MIME type is not text and content is base64-encoded.
`truncated`	`boolean`	Yes	True when content was cut at the read cap; import the file to get all of it.

Full schemas

{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "provider": {
      "type": "string",
      "enum": [
        "onedrive",
        "sharepoint",
        "drive"
      ],
      "description": "External storage provider: \"onedrive\", \"sharepoint\" or \"drive\" (Google Drive)."
    },
    "file_id": {
      "type": "string",
      "description": "File ID from list_external_files"
    }
  },
  "required": [
    "provider",
    "file_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the read_external_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Agent-readable status message or rendered content for the external storage operation."
    },
    "content": {
      "type": "string",
      "description": "File content. UTF-8 text for a text MIME type, base64-encoded bytes when is_binary is true."
    },
    "is_binary": {
      "type": "boolean",
      "description": "True when the MIME type is not text and content is base64-encoded."
    },
    "truncated": {
      "type": "boolean",
      "description": "True when content was cut at the read cap; import the file to get all of it."
    }
  },
  "required": [
    "message",
    "content",
    "is_binary",
    "truncated"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the read_external_file tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get started

APIs

REST API

GraphQL API

MCP API

Read external file

Access

Arguments

Example request

Result

Full schemas

​Access

​Arguments

​Example request

​Result

​Full schemas

Access

Arguments

Example request

Result

Full schemas