PDF Reader MCP Server

🚀 PDF リーダー

PDF リーダーは、PDF ファイルの読み取りや情報抽出を安全かつ効率的に行うツールです。様々な機能を備え、MCP 環境との統合も容易です。

🚀 クイックスタート

PDF リーダーを使用するには、まずインストールが必要です。以下のコマンドを使用して、npm でインストールできます。

npm install @pdf-reader/core

インストール後、以下のコード例を参考に、PDF ファイルのテキストを抽出できます。

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 を使用して入力検証を実現します。

📦 インストール

この PDF リーダーをインストールするには、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 ソースファイルを一度に処理する
import { PDFReader } from '@pdf-reader/core';

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

main().catch(console.error);

📚 ドキュメント

• 機能の詳細：PDF リーダーは、PDF ファイルの全文、特定のページ、メタデータ、ページ数などを読み取ることができます。また、複数の PDF ソースファイルを一度に処理することもできます。
• 設計理念：このサーバーは、安全性を最優先に考慮し、コンテキストを制限することでファイルアクセスの安全性を実現しています。また、AI エージェントのワークフローとの統合を容易にするため、効率性と簡潔性にも配慮して設計されています。
• 性能に関する詳細：Vitest を使用したベンチマークテストの結果、このツールはさまざまな操作を効率的に処理できることが示されています。詳細については、性能ドキュメント を参照してください。

性能ベンチマーク

以下は、Vitest を使用してサンプル PDF で行ったベンチマークテストの結果です。

（より高い hz 値は、より良いパフォーマンスを示します。実際の結果は、PDF ファイルの複雑さや環境によって異なる場合があります。）

🔧 技術詳細

• 依存関係：この PDF リーダーは、pdfjs-dist ライブラリを使用して PDF ファイルを解析し、Zod を使用して入力検証を行います。
• セキュリティ：サーバーは、定義されたプロジェクトのルートディレクトリ内で安全に実行され、ファイルアクセスは制限されています。
• 出力形式：解析結果は、構造化された JSON 形式で提供され、MCP インターフェイスを介して渡すことができます。

📄 ライセンス

本プロジェクトのライセンスに関する詳細は、ライセンス文書 を参照してください。

コンタクト

フィードバックや質問がある場合は、メンテナンスチーム にお問い合わせください。

PDF リーダーをご利用いただき、ありがとうございます！