Skip to main content
Glama
pdfdotco

PDF.co MCP Server

Official
by pdfdotco

fill_forms

Fill existing form fields in PDF documents using field names and values. Use after reading form information to populate text in specified fields.

Instructions

Fill existing form fields in a PDF document.

Example fields format:
[
    {
        "fieldName": "field_name_from_form_info",
        "pages": "1",
        "text": "Value to fill"
    }
]

Use 'read_pdf_forms_info' first to get the fieldName values of the form.

Ref: https://developer.pdf.co/api-reference/pdf-add#create-fillable-pdf-forms.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesURL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files.
fieldsYesList of fields to fill. Each field is a dict with 'fieldName', 'pages', and 'text' properties.
nameNoFile name for the generated output. (Optional)
httpusernameNoHTTP auth user name if required to access source url. (Optional)
httppasswordNoHTTP auth password if required to access source url. (Optional)
api_keyNoPDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional)

Implementation Reference

  • Handler function decorated with @mcp.tool(name="fill_forms"). Defines input schema via Pydantic Fields and calls the helper to fill PDF forms.
    @mcp.tool(name="fill_forms")
    async def fill_pdf_forms(
        url: str = Field(
            description="URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files."
        ),
        fields: list = Field(
            description="List of fields to fill. Each field is a dict with 'fieldName', 'pages', and 'text' properties."
        ),
        name: str = Field(
            description="File name for the generated output. (Optional)", default=""
        ),
        httpusername: str = Field(
            description="HTTP auth user name if required to access source url. (Optional)",
            default="",
        ),
        httppassword: str = Field(
            description="HTTP auth password if required to access source url. (Optional)",
            default="",
        ),
        api_key: str = Field(
            description="PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional)",
            default="",
        ),
    ) -> BaseResponse:
        """
        Fill existing form fields in a PDF document.
    
        Example fields format:
        [
            {
                "fieldName": "field_name_from_form_info",
                "pages": "1",
                "text": "Value to fill"
            }
        ]
    
        Use 'read_pdf_forms_info' first to get the fieldName values of the form.
    
        Ref: https://developer.pdf.co/api-reference/pdf-add#create-fillable-pdf-forms.md
        """
        params = ConversionParams(
            url=url,
            httpusername=httpusername,
            httppassword=httppassword,
            name=name,
        )
    
        return await fill_pdf_form_fields(params, fields=fields, api_key=api_key)
  • Core implementation that prepares the payload with form fields and invokes the PDF.co API via the 'request' function to fill the forms.
    async def fill_pdf_form_fields(
        params: ConversionParams,
        fields: list | None = None,
        annotations: list | None = None,
        api_key: str | None = None,
    ) -> BaseResponse:
        custom_payload = {}
        if fields:
            custom_payload["fields"] = fields
        if annotations:
            custom_payload["annotations"] = annotations
        return await request(
            "pdf/edit/add", params, custom_payload=custom_payload, api_key=api_key
        )
  • Input schema defined in the handler function parameters using Pydantic Fields, including url, fields list, name, auth params, and api_key.
        url: str = Field(
            description="URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files."
        ),
        fields: list = Field(
            description="List of fields to fill. Each field is a dict with 'fieldName', 'pages', and 'text' properties."
        ),
        name: str = Field(
            description="File name for the generated output. (Optional)", default=""
        ),
        httpusername: str = Field(
            description="HTTP auth user name if required to access source url. (Optional)",
            default="",
        ),
        httppassword: str = Field(
            description="HTTP auth password if required to access source url. (Optional)",
            default="",
        ),
        api_key: str = Field(
            description="PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional)",
            default="",
        ),
    ) -> BaseResponse:
        """
        Fill existing form fields in a PDF document.
    
        Example fields format:
        [
            {
                "fieldName": "field_name_from_form_info",
                "pages": "1",
                "text": "Value to fill"
            }
        ]
    
        Use 'read_pdf_forms_info' first to get the fieldName values of the form.
    
        Ref: https://developer.pdf.co/api-reference/pdf-add#create-fillable-pdf-forms.md
        """
        params = ConversionParams(
            url=url,
            httpusername=httpusername,
            httppassword=httppassword,
            name=name,
        )
    
        return await fill_pdf_form_fields(params, fields=fields, api_key=api_key)
  • MCP tool registration decorator specifying the tool name 'fill_forms'.
    @mcp.tool(name="fill_forms")
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It describes the core action (filling form fields) and provides an example format, but lacks details on permissions, rate limits, whether the operation is reversible, or what the output looks like (e.g., returns a modified PDF). The reference link adds some context but doesn't fully compensate for missing behavioral traits.

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 appropriately sized and front-loaded with the core purpose. The example format and prerequisite guidance are useful additions. However, the reference link could be integrated more smoothly, and there's some redundancy with the schema (e.g., field format details). Overall, it's efficient but not perfectly structured.

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

Completeness3/5

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

Given the complexity (6 parameters, no output schema, no annotations), the description is moderately complete. It covers the purpose, usage prerequisite, and field format, but lacks output details, error handling, or behavioral constraints. For a tool that modifies PDFs, more context on side effects or result format would be beneficial.

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 schema already documents all parameters thoroughly. The description adds minimal value by providing an example format for the 'fields' parameter, but doesn't explain parameter interactions or semantics beyond what's in the schema. This meets the baseline for high schema coverage.

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

Purpose4/5

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

The description clearly states the tool's purpose: 'Fill existing form fields in a PDF document.' This specifies the verb ('fill'), resource ('existing form fields'), and target ('PDF document'). However, it doesn't explicitly differentiate from sibling tools like 'create_fillable_forms' or 'pdf_add_annotations_images_fields', which prevents a perfect score.

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

Usage Guidelines4/5

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

The description provides clear usage guidance by stating 'Use 'read_pdf_forms_info' first to get the fieldName values of the form.' This gives a specific prerequisite and references another tool. However, it doesn't explicitly state when NOT to use this tool or mention alternatives like 'create_fillable_forms' for creating new forms versus filling existing ones.

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/pdfdotco/pdfco-mcp'

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