Skip to main content

A Model Context Protocol (MCP) server that provides tools for reading and extracting text from PDF files

Project description

PDF Reader MCP Server

A Model Context Protocol (MCP) server that provides tools for reading and extracting text from PDF files, supporting both local files and URLs.

Author

Philip Van de Walker
Email: philip.vandewalker@gmail.com
GitHub: https://github.com/trafflux

Features

  • Read text content from local PDF files
  • Read text content from PDF URLs
  • Error handling for corrupt or invalid PDFs
  • Volume mounting for accessing local PDFs
  • Auto-detection of PDF encoding
  • Standardized JSON output format

Installation

  1. Clone the repository:
git clone https://github.com/trafflux/pdf-reader-mcp.git
cd pdf-reader-mcp
  1. Build the Docker image:
docker build -t mcp/pdf-reader .

Usage

Running the Server

To run the server with access to local PDF files:

docker run -i --rm -v /path/to/pdfs:/pdfs mcp/pdf-reader

Replace /path/to/pdfs with the actual path to your PDF files directory.

If not using local PDF files:

docker run -i --rm mcp/pdf-reader

MCP Configuration

Add to your MCP settings configuration:

{
  "mcpServers": {
    "pdf-reader": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v",
        "/path/to/pdfs:/pdfs",
        "mcp/pdf-reader"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

Without local file PDF files:

{
  "mcpServers": {
    "pdf-reader": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "mcp/pdf-reader"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

Available Tools

  1. read_local_pdf

    • Purpose: Read text content from a local PDF file
    • Input:
      {
        "path": "/pdfs/document.pdf"
      }
      
    • Output:
      {
        "success": true,
        "data": {
          "text": "Extracted content..."
        }
      }
      
  2. read_pdf_url

    • Purpose: Read text content from a PDF URL
    • Input:
      {
        "url": "https://example.com/document.pdf"
      }
      
    • Output:
      {
        "success": true,
        "data": {
          "text": "Extracted content..."
        }
      }
      

Error Handling

The server handles various error cases with clear error messages:

  • Invalid or corrupt PDF files
  • Missing files
  • Failed URL requests
  • Permission issues
  • Network connectivity problems

Error responses follow the format:

{
  "success": false,
  "error": "Detailed error message"
}

Dependencies

  • Python 3.11+
  • PyPDF2: PDF parsing and text extraction
  • requests: HTTP client for fetching PDFs from URLs
  • MCP SDK: Model Context Protocol implementation

Project Structure

.
├── Dockerfile          # Container configuration
├── README.md          # This documentation
├── requirements.txt   # Python dependencies
└── src/
    ├── __init__.py    # Package initialization
    └── server.py      # Main server implementation

License

Copyright 2025 Philip Van de Walker

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Contact

For questions, issues, or contributions, please contact Philip Van de Walker:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_pdf_reader-1.0.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_pdf_reader-1.0.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_pdf_reader-1.0.0.tar.gz.

File metadata

File hashes

Hashes for iflow_mcp_pdf_reader-1.0.0.tar.gz
Algorithm Hash digest
SHA256 49648611804eb8857411f2e86f12c4574efdce91cfc2c1e8df53ad076646d587
MD5 0690a6e95d36e2222195a5ac4dc71e12
BLAKE2b-256 fc79a7c70c07cfe254e9c5370786713bc9e6824519e20e112699de2b32de0a05

See more details on using hashes here.

File details

Details for the file iflow_mcp_pdf_reader-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iflow_mcp_pdf_reader-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b824d97d69e4fa2db98e350709512452473ccabea04c1cf8775547d7cedfeb2b
MD5 dd8efe20cd9e65944030b7adb46eebfe
BLAKE2b-256 702168296e30fe3c5f2fd4832f4d92d77f2c95debb49414e60e46b419a041bf8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page