veryfront__import_external_fileAccess
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Can change resources.Arguments
| Field | Type | Required | Description and constraints |
|---|---|---|---|
project_reference | string | No | Project ID or slug. Requires project.uploads.write and destination upload edit permission; quota and plan limits apply. Uses the caller’s own personal provider connection. |
provider | string | Yes | Storage provider accessed through the caller’s own personal connection. A shared project connection is not used. Values: "onedrive", "sharepoint", "drive". |
file_id | string | Yes | File ID from list_external_files Minimum length: 1. Maximum length: 1024. |
base_path | string | No | Older name for folder_path. Destination folder path prefix in project object storage (e.g., “my-docs” → “my-docs/{filename}”). Defaults to “external-imports/{timestamp}_{filename}”. |
folder_path | string | No | Destination folder inside project Uploads, relative (no leading ”/”). Defaults to “external-imports” with a timestamped name. Minimum length: 1. |
timestamp_prefix | boolean | No | Prefix the stored name with a timestamp. Defaults to true when no folder is given, false otherwise. |
visibility | string | No | Visibility of the new upload: “project”, “public” or “private”. Omitted, the upload inherits the destination folder’s visibility. Setting it needs upload admin access on the destination, and “public” a paid plan; a refusal imports nothing. Values: "project", "public", "private". |
idempotency_key | string | No | Optional key of 1-128 characters without whitespace. Retrying with the same key and arguments within 24 hours returns the first result instead of creating another item; the same key with different arguments is refused. Minimum length: 1. Maximum length: 128. |
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__import_external_file",
"arguments": {
"provider": "onedrive",
"file_id": "example"
}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError 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. |
upload | object | Yes | The upload the file was copied into. |
source | object | Yes | The provider file that was imported. |
Full schemas
{
"type": "object",
"properties": {
"project_reference": {
"type": "string",
"description": "Project ID or slug. Requires project.uploads.write and destination upload edit permission; quota and plan limits apply. Uses 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."
},
"file_id": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "File ID from list_external_files"
},
"base_path": {
"type": "string",
"description": "Older name for folder_path. Destination folder path prefix in project object storage (e.g., \"my-docs\" → \"my-docs/{filename}\"). Defaults to \"external-imports/{timestamp}_{filename}\"."
},
"folder_path": {
"type": "string",
"minLength": 1,
"description": "Destination folder inside project Uploads, relative (no leading \"/\"). Defaults to \"external-imports\" with a timestamped name."
},
"timestamp_prefix": {
"type": "boolean",
"description": "Prefix the stored name with a timestamp. Defaults to true when no folder is given, false otherwise."
},
"visibility": {
"type": "string",
"enum": [
"project",
"public",
"private"
],
"description": "Visibility of the new upload: \"project\", \"public\" or \"private\". Omitted, the upload inherits the destination folder's visibility. Setting it needs upload admin access on the destination, and \"public\" a paid plan; a refusal imports nothing."
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^\\S+$",
"description": "Optional key of 1-128 characters without whitespace. Retrying with the same key and arguments within 24 hours returns the first result instead of creating another item; the same key with different arguments is refused."
}
},
"required": [
"provider",
"file_id"
],
"additionalProperties": false,
"description": "Arguments for the import_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."
},
"upload": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "Unique identifier for the returned record."
},
"project_id": {
"$ref": "#/properties/upload/properties/id",
"description": "Project identifier associated with this result."
},
"path": {
"type": "string"
},
"name": {
"type": "string",
"description": "Stored provider file name. Google Docs and Slides export as PDF; Sheets export as XLSX, retaining the exported extension."
},
"mime_type": {
"type": "string",
"minLength": 1
},
"size_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"visibility": {
"type": "string",
"enum": [
"project",
"public",
"private"
]
}
},
"required": [
"id",
"project_id",
"path",
"name",
"mime_type",
"size_bytes",
"visibility"
],
"additionalProperties": false,
"description": "The upload the file was copied into."
},
"source": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"onedrive",
"sharepoint",
"drive"
]
},
"file_id": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"provider",
"file_id"
],
"additionalProperties": false,
"description": "The provider file that was imported."
}
},
"required": [
"message",
"upload",
"source"
],
"additionalProperties": false,
"description": "Structured result returned by the import_external_file tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}