Pdf Reader MCP

🚀 PDF 閱讀器 MCP 服務器

本項目是一個基於 Model Context Protocol (MCP) 的服務器，可從 PDF 文件中讀取並提取文本內容，支持本地文件和 URL 兩種方式，為 PDF 文本處理提供了便捷的解決方案。

🚀 快速開始

安裝步驟

1. 克隆倉庫：

git clone https://github.com/trafflux/pdf-reader-mcp.git
cd pdf-reader-mcp

2. 構建 Docker 鏡像：

docker build -t mcp/pdf-reader .

運行服務器

要運行具有訪問本地 PDF 文件權限的服務器：

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

請將 /path/to/pdfs 替換為實際的 PDF 文件路徑。

如果不使用本地 PDF 文件：

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

MCP 配置

添加到您的 MCP 設置配置中：

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

不使用本地 PDF 文件的情況：

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

✨ 主要特性

• 支持從本地 PDF 文件中讀取文本內容。
• 支持從 PDF URLs 中讀取文本內容。
• 具備處理損壞或無效 PDF 的錯誤處理機制。
• 可通過卷掛載訪問本地 PDF 文件。
• 能自動檢測 PDF 編碼。
• 採用標準化的 JSON 輸出格式。

💻 使用示例

基礎用法

1. read_local_pdf

• 目的：從本地 PDF 文件中讀取文本內容
• 輸入：

{
  "path": "/pdfs/document.pdf"
}

• 輸出：

{
  "success": true,
  "data": {
    "text": "提取的內容..."
  }
}

2. read_pdf_url

• 目的：從指定的 PDF URL 中讀取文本內容
• 輸入：

{
  "url": "http://example.com/example.pdf"
}

• 輸出：

{
  "success": true,
  "data": {
    "text": "提取的內容..."
  }
}

📚 詳細文檔

錯誤處理

服務器在遇到錯誤時會返回以下 JSON 格式的響應：

{
  "success": false,
  "error": {
    "code": " ErrorCode ",
    "message": " 錯誤信息 "
  }
}

其中，ErrorCode 是一個唯一的錯誤代碼，Error Message 描述了具體的錯誤原因。

依賴項

• Python 版本：3.8 或更高
• 必要庫：
  • Flask (用於 Web 服務)
  • requests (用於處理 URL 請求)

項目結構

.
├── README.md                # 項目文檔
├── requirements.txt        # 依賴項列表
├── app.py                  # 主應用程序文件
└── config.py               # 配置文件

📄 許可證

本項目受 Apache License 2.0 許可證的約束。詳細內容請參考 LICENSE 文件。

👨‍💻 作者

• 作者：Philip Van de Walker
• 郵箱：philip.vandewalker@gmail.com
• GitHub：https://github.com/trafflux

📞 聯繫方式

如需聯繫，請發送郵件至 philip.vandewalker@gmail.com 或訪問 GitHub 倉庫：https://github.com/trafflux/pdf-reader-mcp