PDF.co MCP Server

Instructions

Add password protection to a PDF file.
Ref: https://developer.pdf.co/api-reference/pdf-password/add.md

Implementation Reference

• pdfco/mcp/tools/apis/security.py:8-119 (handler)

  MCP tool handler for 'pdf_add_password'. Includes @mcp.tool() decorator for registration, detailed input schema via Pydantic Fields, and logic to build parameters before calling the service helper.

  @mcp.tool()
  async def pdf_add_password(
      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."
      ),
      owner_password: str = Field(
          description="The main owner password that is used for document encryption and for setting/removing restrictions."
      ),
      user_password: str = Field(
          description="The optional user password will be asked for viewing and printing document.",
          default="",
      ),
      encryption_algorithm: str = Field(
          description="Encryption algorithm. Valid values: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. AES_128bit or higher is recommended.",
          default="AES_256bit",
      ),
      allow_accessibility_support: bool = Field(
          description="Allow or prohibit content extraction for accessibility needs.",
          default=False,
      ),
      allow_assembly_document: bool = Field(
          description="Allow or prohibit assembling the document.", default=False
      ),
      allow_print_document: bool = Field(
          description="Allow or prohibit printing PDF document.", default=False
      ),
      allow_fill_forms: bool = Field(
          description="Allow or prohibit the filling of interactive form fields (including signature fields) in the PDF documents.",
          default=False,
      ),
      allow_modify_document: bool = Field(
          description="Allow or prohibit modification of PDF document.", default=False
      ),
      allow_content_extraction: bool = Field(
          description="Allow or prohibit copying content from PDF document.",
          default=False,
      ),
      allow_modify_annotations: bool = Field(
          description="Allow or prohibit interacting with text annotations and forms in PDF document.",
          default=False,
      ),
      print_quality: str = Field(
          description="Allowed printing quality. Valid values: HighResolution, LowResolution.",
          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="",
      ),
      password: str = Field(
          description="Password of the PDF file if it's already password-protected. (Optional)",
          default="",
      ),
      name: str = Field(
          description="File name for the generated output. (Optional)", default=""
      ),
      api_key: str = Field(
          description="PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional)",
          default="",
      ),
  ) -> BaseResponse:
      """
      Add password protection to a PDF file.
      Ref: https://developer.pdf.co/api-reference/pdf-password/add.md
      """
      params = ConversionParams(
          url=url,
          httpusername=httpusername,
          httppassword=httppassword,
          password=password,
          name=name,
      )
  
      additional_params = {
          "ownerPassword": owner_password,
      }
  
      if user_password is not None:
          additional_params["userPassword"] = user_password
  
      if encryption_algorithm is not None:
          additional_params["EncryptionAlgorithm"] = encryption_algorithm
  
      if allow_accessibility_support is not None:
          additional_params["AllowAccessibilitySupport"] = allow_accessibility_support
  
      if allow_assembly_document is not None:
          additional_params["AllowAssemblyDocument"] = allow_assembly_document
  
      if allow_print_document is not None:
          additional_params["AllowPrintDocument"] = allow_print_document
  
      if allow_fill_forms is not None:
          additional_params["AllowFillForms"] = allow_fill_forms
  
      if allow_modify_document is not None:
          additional_params["AllowModifyDocument"] = allow_modify_document
  
      if allow_content_extraction is not None:
          additional_params["AllowContentExtraction"] = allow_content_extraction
  
      if allow_modify_annotations is not None:
          additional_params["AllowModifyAnnotations"] = allow_modify_annotations
  
      if print_quality is not None:
          additional_params["PrintQuality"] = print_quality
  
      return await add_pdf_password(params, **additional_params, api_key=api_key)

• pdfco/mcp/services/pdf.py:101-106 (helper)

  Service helper function that performs the actual HTTP request to the PDF.co API endpoint for adding password to PDF.

  async def add_pdf_password(
      params: ConversionParams, api_key: str | None = None, **kwargs
  ) -> BaseResponse:
      return await request(
          "pdf/security/add", params, custom_payload=kwargs, api_key=api_key
      )

• pdfco/mcp/tools/apis/security.py:72-119 (schema)

  Output type annotation using BaseResponse model for standardized response handling.

  ) -> BaseResponse:
      """
      Add password protection to a PDF file.
      Ref: https://developer.pdf.co/api-reference/pdf-password/add.md
      """
      params = ConversionParams(
          url=url,
          httpusername=httpusername,
          httppassword=httppassword,
          password=password,
          name=name,
      )
  
      additional_params = {
          "ownerPassword": owner_password,
      }
  
      if user_password is not None:
          additional_params["userPassword"] = user_password
  
      if encryption_algorithm is not None:
          additional_params["EncryptionAlgorithm"] = encryption_algorithm
  
      if allow_accessibility_support is not None:
          additional_params["AllowAccessibilitySupport"] = allow_accessibility_support
  
      if allow_assembly_document is not None:
          additional_params["AllowAssemblyDocument"] = allow_assembly_document
  
      if allow_print_document is not None:
          additional_params["AllowPrintDocument"] = allow_print_document
  
      if allow_fill_forms is not None:
          additional_params["AllowFillForms"] = allow_fill_forms
  
      if allow_modify_document is not None:
          additional_params["AllowModifyDocument"] = allow_modify_document
  
      if allow_content_extraction is not None:
          additional_params["AllowContentExtraction"] = allow_content_extraction
  
      if allow_modify_annotations is not None:
          additional_params["AllowModifyAnnotations"] = allow_modify_annotations
  
      if print_quality is not None:
          additional_params["PrintQuality"] = print_quality
  
      return await add_pdf_password(params, **additional_params, api_key=api_key)

• pdfco/mcp/tools/apis/security.py:8-8 (registration)

  Decorator that registers the function as an MCP tool named 'pdf_add_password'.

  @mcp.tool()