PDF Reader MCP Server

🚀 PDF 閱讀器

PDF 閱讀器是一款功能強大的工具，它能安全、靈活地讀取 PDF 文件，通過單個工具滿足多種提取需求，並以結構化的 JSON 格式輸出數據，便於集成到各類環境中。

🚀 快速開始

使用 npm 安裝該工具：

npm install @pdf-reader/core

示例代碼如下：

import { PDFReader } from '@pdf-reader/core';

async function main() {
    const reader = new PDFReader();
    const text = await reader.extractText('path/to/your.pdf');
    console.log(text);
}

main().catch(console.error);

✨ 主要特性

• 🛡️ 安全性：嚴格限制文件訪問權限，僅限於項目根目錄。
• 🌐 靈活性：支持本地相對路徑和公共 URL。
• 🧩 統一功能：單個 read_pdf 工具即可實現多種提取需求（全文本、特定頁面、元數據、頁數統計）。
• ⚙️ 結構化輸出：返回易於解析的預測 JSON 格式數據。
• 🚀 易於集成：設計用於通過 npx 或 Docker 容器在 MCP 環境中無縫使用。
• ✅ 可靠性：使用 pdfjs-dist 進行可靠的解析，並藉助 Zod 實現輸入驗證。

📦 安裝指南

使用 npm 進行安裝：

npm install @pdf-reader/core

💻 使用示例

基礎用法

import { PDFReader } from '@pdf-reader/core';

async function main() {
    const reader = new PDFReader();
    const text = await reader.extractText('path/to/your.pdf');
    console.log(text);
}

main().catch(console.error);

高級用法

// 在單次請求中處理多個 PDF 源文件（本地路徑或 URL）
import { PDFReader } from '@pdf-reader/core';

async function main() {
    const reader = new PDFReader();
    const sources = ['path/to/local.pdf', 'https://example.com/remote.pdf'];
    const results = await reader.processMultipleSources(sources);
    console.log(results);
}

main().catch(console.error);

📚 詳細文檔

功能

• 讀取 PDF 文件的全文本內容。
• 提取特定頁面或頁面範圍的文本內容。
• 讀取 PDF 的元數據（作者、標題、創建日期等）。
• 獲取 PDF 的總頁數。
• 在單次請求中處理多個 PDF 源文件（本地路徑或 URL）。
• 安全地在定義的項目根目錄內運行。
• 提供結構化的 JSON 輸出，通過 MCP 接口傳遞。

設計理念

該服務器優先考慮安全性，通過限制上下文來實現文件訪問的安全性。同時，其設計注重高效性和簡潔性，便於與 AI 代理工作流程集成。它依賴於最少的依賴項，並使用可靠的 pdfjs-dist 庫進行 PDF 解析。有關完整的 設計理念文檔。

功能對比

與其他解決方案相比：

• 與直接文件訪問：提供了針對 PDF 的特定解析功能。
• 與通用文件系統工具 (例如 pdftotext)：通過 MCP 接口提供了一個安全、集成的界面，並生成結構化的輸出，提高了可靠性和易用性。有關完整 對比文檔。

未來計劃（路線圖）

• 文檔：
  • 完成所有文檔部分（指南、API 參考、設計、比較）。
  • 解決 TypeDoc 問題並生成 API 文檔。
  • 添加更多示例和高級用法。
  • 實現 PWA 支持並在移動設備上進行優化。
  • 在文檔網站中添加分享按鈕和增長指標。
• 基準測試：使用各種 PDF 文件（大小、複雜度）進行全面測試。
• 性能優化：優化現有功能，提升處理速度和效率。

依賴項

• pdfjs-dist：使用 pdf.js 庫來處理和解析 PDF 文件。
• Zod：用於輸入驗證和類型安全。

貢獻指南

歡迎社區貢獻！請參考 貢獻文檔 瞭解如何參與開發。

文檔鏈接

有關詳細信息，請參閱項目文檔：

• 快速入門指南
• API 參考文檔
• 設計原則

🔧 技術細節

性能優勢

初步使用 Vitest 對示例 PDF 進行基準測試，結果顯示該工具對各種操作的處理效率較高：

（更高的 hz 值表示性能越好。實際結果可能因 PDF 文件的複雜性和環境而異。）

有關更多詳細信息，請參閱 性能文檔。

📄 許可證

文檔中未提及相關內容，暫不展示。

📞 聯繫方式

如需反饋或問題，請聯繫 維護團隊。

感謝您使用 PDF 閱讀器！