Skip to main content
Glama
mabeldata

PocketBase MCP Server

by mabeldata

download_file

Get a download URL for a file stored in a PocketBase collection record field by specifying collection, record ID, and file field name.

Instructions

Get the URL to download a file from a PocketBase collection record field.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collectionYesThe name or ID of the collection.
recordIdYesThe ID of the record containing the file.
fileFieldYesThe name of the file field.

Implementation Reference

  • The core handler function for download_file. It fetches the record from PocketBase, extracts the filename from the specified file field, generates a download URL using pb.files.getUrl(), and returns the URL to the client.
    async function downloadFile(args: DownloadFileArgs, pb: PocketBase): Promise<ToolResult> {
        if (!args.collection || !args.recordId || !args.fileField) {
            throw invalidParamsError("Missing required arguments: collection, recordId, fileField");
        }
    
        // Fetch the record to get the filename associated with the file field
        const record = await pb.collection(args.collection).getOne(args.recordId, {
            // Optionally specify fields to fetch only the necessary data
            // fields: `${args.fileField}`
        });
    
        // Ensure the file field exists and has a value
        const fileName = record[args.fileField];
        if (!fileName || typeof fileName !== 'string') {
             throw invalidParamsError(`File field '${args.fileField}' not found or empty on record ${args.recordId}`);
        }
    
        // Get the file URL using the filename from the record
        const fileUrl = pb.files.getUrl(record, fileName); // Use pb.files.getUrl
    
        // Return the URL to the client
        return {
            content: [{ type: 'text', text: `Download URL for ${fileName}: ${fileUrl}` }],
        };
    }
  • The DownloadFileArgs interface defining the expected input parameters: collection, recordId, fileField, and downloadPath (though downloadPath is unused in the handler).
    export interface DownloadFileArgs {
      collection: string;
      recordId: string;
      fileField: string;
      downloadPath: string;
    }
  • The routing logic in handleToolCall that dispatches 'download_file' to handleFileToolCall in file-tools.ts.
        } else if (name === 'upload_file' || name === 'download_file') {
            return handleFileToolCall(name, toolArgs, pb);
        } else if (name === 'create_migration' || name === 'create_collection_migration' || name === 'add_field_migration' || name === 'list_migrations') {
            return handleMigrationToolCall(name, toolArgs, pb);
        } else if (name === 'list_logs' || name === 'get_log' || name === 'get_logs_stats') {
            return handleLogToolCall(name, toolArgs, pb);
        } else if (name === 'list_cron_jobs' || name === 'run_cron_job') {
            return handleCronToolCall(name, toolArgs, pb);
        } else {
            throw methodNotFoundError(name);
        }
    }
  • The tool definition/registration metadata for 'download_file', including its description, inputSchema (collection, recordId, fileField), and required fields.
    {
        name: 'download_file',
        description: 'Get the URL to download a file from a PocketBase collection record field.',
        inputSchema: {
            type: 'object',
            properties: {
                collection: { type: 'string', description: 'The name or ID of the collection.' },
                recordId: { type: 'string', description: 'The ID of the record containing the file.' },
                fileField: { type: 'string', description: 'The name of the file field.' },
                // downloadPath is removed - server cannot directly save files for the client
            },
            required: ['collection', 'recordId', 'fileField']
        }
    }
  • The handleFileToolCall helper function that routes 'download_file' to the downloadFile handler.
    export async function handleFileToolCall(name: string, args: any, pb: PocketBase): Promise<ToolResult> {
        switch (name) {
            case 'upload_file':
                return uploadFile(args as UploadFileArgs, pb);
            case 'download_file':
                return downloadFile(args as DownloadFileArgs, pb);
            default:
                throw new Error(`Unknown file tool: ${name}`);
        }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. It only states 'Get the URL to download a file' without specifying whether the URL is temporary, requires authentication, or what happens if the file is missing. This lack of detail is a significant gap for a tool that interacts with a data store.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, which is concise and front-loaded. However, it is overly minimal and could benefit from additional context (e.g., return value or usage example) without becoming verbose. Still, it earns its place as a succinct statement of purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's low complexity (3 parameters, no output schema), the description should be nearly complete but falls short. It omits the return type (a URL string), possible error scenarios (e.g., file not found), and any prerequisites like authentication. The description is barely adequate for an agent to use the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond the schema's parameter descriptions (collection, recordId, fileField). It does not clarify constraints, formatting, or default behaviors for the parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool gets a URL to download a file from a PocketBase collection record field, specifying the verb 'Get' and the resource 'URL to download a file'. It distinguishes from sibling tools like 'fetch_record' (which retrieves the record) and 'upload_file' (which uploads a file).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for downloading files but does not explicitly state when to use this tool versus alternatives (e.g., 'upload_file' or 'fetch_record'). No exclusions or prerequisites are mentioned, leaving the agent to infer context from the tool's name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mabeldata/pocketbase-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server