Forest Admin - API reference
    Preparing search index...

    Interface FileUploadsOptionsExperimental

    The MCP specification is still designing its own file transfer story (SEP-2631). The storage contract is expected to survive, but the requestActionFileUpload tool and the handle format may change to follow the specification once it lands.

    interface FileUploadsOptions {
        downloadTimeoutSeconds?: number;
        ephemeralMaxTotalBytes?: number;
        handleTtlSeconds?: number;
        keyPrefix?: string;
        maxBytes?: number;
        maxConcurrentDownloads?: number;
        storage?: UploadStorage;
        uploadUrlTtlSeconds?: number;
    }
    Index

    Properties

    downloadTimeoutSeconds? ephemeralMaxTotalBytes? handleTtlSeconds? keyPrefix? maxBytes? maxConcurrentDownloads? storage? uploadUrlTtlSeconds?

    Properties

    downloadTimeoutSeconds?: number

    How long a single storage read may take. Keep it well under the request timeout of the clients calling the agent, so a slow backend fails here rather than being cut mid-flight. Defaults to 15 seconds.

    ephemeralMaxTotalBytes?: number

    Total size the in-memory store holds across all pending uploads. Defaults to 64 MiB. Has no effect once a storage is given.

    handleTtlSeconds?: number

    Must stay longer than uploadUrlTtlSeconds, so a slow upload leaves time to run the action.

    keyPrefix?: string
    maxBytes?: number
    maxConcurrentDownloads?: number
    storage?: UploadStorage

    Where uploaded objects live between the upload and the action. Omit it and the server keeps them in memory, on its own origin — nothing to provision, but only correct for a single instance: see the README.

    uploadUrlTtlSeconds?: number

    Settings

    Member Visibility

    On This Page

    Properties