@sylphx/pdf-reader-mcp 1.3.0 โ†’ 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +110 -78
  2. package/dist/index.js +524 -45
  3. package/package.json +17 -11
  4. package/dist/handlers/index.js +0 -4
  5. package/dist/handlers/readPdf.js +0 -170
  6. package/dist/pdf/extractor.js +0 -394
  7. package/dist/pdf/loader.js +0 -53
  8. package/dist/pdf/parser.js +0 -96
  9. package/dist/schemas/readPdf.js +0 -59
  10. package/dist/types/pdf.js +0 -2
  11. package/dist/utils/pathUtils.js +0 -25
package/README.md CHANGED
@@ -1,19 +1,20 @@
1
1
  <div align="center">
2
2
 
3
- # PDF Reader MCP โšก
3
+ # PDF Reader MCP ๐Ÿ“„
4
4
 
5
- **The fastest and most powerful PDF processing server for AI agents**
5
+ **Production-ready PDF processing server for AI agents**
6
6
 
7
- [![CI/CD](https://github.com/sylphxltd/pdf-reader-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/sylphxltd/pdf-reader-mcp/actions/workflows/ci.yml)
8
- [![codecov](https://codecov.io/gh/sylphxltd/pdf-reader-mcp/graph/badge.svg?token=VYRQFB40UN)](https://codecov.io/gh/sylphxltd/pdf-reader-mcp)
9
- [![npm version](https://badge.fury.io/js/%40sylphx%2Fpdf-reader-mcp.svg)](https://www.npmjs.com/package/@sylphx/pdf-reader-mcp)
10
- [![Downloads](https://img.shields.io/npm/dm/@sylphx/pdf-reader-mcp.svg)](https://www.npmjs.com/package/@sylphx/pdf-reader-mcp)
11
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+ [![CI/CD](https://img.shields.io/github/actions/workflow/status/SylphxAI/pdf-reader-mcp/ci.yml?style=flat-square&label=CI/CD)](https://github.com/SylphxAI/pdf-reader-mcp/actions/workflows/ci.yml)
8
+ [![codecov](https://img.shields.io/codecov/c/github/SylphxAI/pdf-reader-mcp?style=flat-square)](https://codecov.io/gh/SylphxAI/pdf-reader-mcp)
9
+ [![npm version](https://img.shields.io/npm/v/@sylphx/pdf-reader-mcp?style=flat-square)](https://www.npmjs.com/package/@sylphx/pdf-reader-mcp)
10
+ [![coverage](https://img.shields.io/badge/coverage-94.17%25-brightgreen?style=flat-square)](https://pdf-reader-msu3esos4-sylphx.vercel.app)
11
+ [![Downloads](https://img.shields.io/npm/dm/@sylphx/pdf-reader-mcp?style=flat-square)](https://www.npmjs.com/package/@sylphx/pdf-reader-mcp)
12
+ [![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](https://opensource.org/licenses/MIT)
12
13
 
13
- **5-10x faster parallel processing** โ€ข **Y-coordinate content ordering** โ€ข **94%+ test coverage** โ€ข **Production-ready**
14
+ **5-10x faster parallel processing** โ€ข **Y-coordinate content ordering** โ€ข **94%+ test coverage** โ€ข **103 tests passing**
14
15
 
15
- <a href="https://mseep.ai/app/sylphxltd-pdf-reader-mcp">
16
- <img src="https://mseep.net/pr/sylphxltd-pdf-reader-mcp-badge.png" alt="Security Validated" width="200"/>
16
+ <a href="https://mseep.ai/app/SylphxAI-pdf-reader-mcp">
17
+ <img src="https://mseep.net/pr/SylphxAI-pdf-reader-mcp-badge.png" alt="Security Validated" width="200"/>
17
18
  </a>
18
19
 
19
20
  </div>
@@ -24,26 +25,72 @@
24
25
 
25
26
  PDF Reader MCP is a **production-ready** Model Context Protocol server that empowers AI agents with **enterprise-grade PDF processing capabilities**. Extract text, images, and metadata with unmatched performance and reliability.
26
27
 
27
- **Stop struggling with PDF extraction. Choose PDF Reader MCP.**
28
+ **The Problem:**
29
+ ```typescript
30
+ // Traditional PDF processing
31
+ - Sequential page processing (slow)
32
+ - No natural content ordering
33
+ - Complex path handling
34
+ - Poor error isolation
35
+ ```
28
36
 
29
- ## โšก Why PDF Reader MCP?
37
+ **The Solution:**
38
+ ```typescript
39
+ // PDF Reader MCP
40
+ - 5-10x faster parallel processing โšก
41
+ - Y-coordinate based ordering ๐Ÿ“
42
+ - Flexible path support (absolute/relative) ๐ŸŽฏ
43
+ - Per-page error resilience ๐Ÿ›ก๏ธ
44
+ - 94%+ test coverage โœ…
45
+ ```
46
+
47
+ **Result: Production-ready PDF processing that scales.**
48
+
49
+ ---
30
50
 
31
- ### **Unmatched Performance**
32
- - ๐Ÿš€ **5-10x faster** than sequential processing with automatic parallelization
33
- - ๐Ÿ”ฅ **Process 50-page PDFs** in seconds with multi-core utilization
34
- - โšก **~12,933 ops/sec** error handling, ~5,575 ops/sec text extraction
35
- - ๐Ÿ’จ **Streaming support** for efficient large file handling
51
+ ## โšก Key Features
52
+
53
+ ### Performance
54
+
55
+ - ๐Ÿš€ **5-10x faster** than sequential with automatic parallelization
56
+ - โšก **12,933 ops/sec** error handling, 5,575 ops/sec text extraction
57
+ - ๐Ÿ’จ **Process 50-page PDFs** in seconds with multi-core utilization
36
58
  - ๐Ÿ“ฆ **Lightweight** with minimal dependencies
37
59
 
38
- ### **Developer Experience**
39
- - ๐ŸŽฏ **Path Flexibility** - Absolute & relative paths, Windows/Unix support (NEW v1.3.0)
40
- - ๐Ÿ–ผ๏ธ **Smart Ordering** - Y-coordinate based content extraction preserves layout
60
+ ### Developer Experience
61
+
62
+ - ๐ŸŽฏ **Path Flexibility** - Absolute & relative paths, Windows/Unix support (v1.3.0)
63
+ - ๐Ÿ–ผ๏ธ **Smart Ordering** - Y-coordinate based content preserves document layout
41
64
  - ๐Ÿ›ก๏ธ **Type Safe** - Full TypeScript with strict mode enabled
42
- - ๐Ÿ“š **Battle-tested** - 103 tests, 94%+ coverage, zero compromises
65
+ - ๐Ÿ“š **Battle-tested** - 103 tests, 94%+ coverage, 98%+ function coverage
43
66
  - ๐ŸŽจ **Simple API** - Single tool handles all operations elegantly
44
67
 
45
68
  ---
46
69
 
70
+ ## ๐Ÿ“Š Performance Benchmarks
71
+
72
+ Real-world performance from production testing:
73
+
74
+ | Operation | Ops/sec | Performance | Use Case |
75
+ |-----------|---------|-------------|----------|
76
+ | **Error handling** | 12,933 | โšกโšกโšกโšกโšก | Validation & safety |
77
+ | **Extract full text** | 5,575 | โšกโšกโšกโšก | Document analysis |
78
+ | **Extract page** | 5,329 | โšกโšกโšกโšก | Single page ops |
79
+ | **Multiple pages** | 5,242 | โšกโšกโšกโšก | Batch processing |
80
+ | **Metadata only** | 4,912 | โšกโšกโšก | Quick inspection |
81
+
82
+ ### Parallel Processing Speedup
83
+
84
+ | Document | Sequential | Parallel | Speedup |
85
+ |----------|-----------|----------|---------|
86
+ | **10-page PDF** | ~2s | ~0.3s | **5-8x faster** |
87
+ | **50-page PDF** | ~10s | ~1s | **10x faster** |
88
+ | **100+ pages** | ~20s | ~2s | **Linear scaling** with CPU cores |
89
+
90
+ *Benchmarks vary based on PDF complexity and system resources.*
91
+
92
+ ---
93
+
47
94
  ## ๐Ÿ“ฆ Installation
48
95
 
49
96
  ```bash
@@ -113,7 +160,7 @@ Add to your MCP client (`claude_desktop_config.json`, Cursor, Cline):
113
160
  }
114
161
  ```
115
162
 
116
- ### Absolute Paths (NEW in v1.3.0!)
163
+ ### Absolute Paths (v1.3.0+)
117
164
 
118
165
  ```json
119
166
  // Windows - Both formats work!
@@ -484,30 +531,6 @@ Restart MCP client completely.
484
531
 
485
532
  ---
486
533
 
487
- ## โšก Performance
488
-
489
- ### Benchmarks
490
-
491
- | Operation | Ops/sec | Performance |
492
- |:----------|:--------|:------------|
493
- | Error handling | ~12,933 | โšกโšกโšกโšกโšก |
494
- | Extract full text | ~5,575 | โšกโšกโšกโšก |
495
- | Extract page | ~5,329 | โšกโšกโšกโšก |
496
- | Multiple pages | ~5,242 | โšกโšกโšกโšก |
497
- | Metadata only | ~4,912 | โšกโšกโšก |
498
-
499
- ### Parallel Processing
500
-
501
- | Document | Speedup |
502
- |:---------|:--------|
503
- | 10-page PDF | **5-8x faster** |
504
- | 50-page PDF | **10x faster** |
505
- | 100+ pages | **Linear scaling** with CPU cores |
506
-
507
- *Benchmarks vary based on PDF complexity and system resources.*
508
-
509
- ---
510
-
511
534
  ## ๐Ÿ—๏ธ Architecture
512
535
 
513
536
  ### Tech Stack
@@ -548,7 +571,7 @@ Restart MCP client completely.
548
571
 
549
572
  **Setup:**
550
573
  ```bash
551
- git clone https://github.com/sylphxltd/pdf-reader-mcp.git
574
+ git clone https://github.com/SylphxAI/pdf-reader-mcp.git
552
575
  cd pdf-reader-mcp
553
576
  pnpm install && pnpm build
554
577
  ```
@@ -600,7 +623,7 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
600
623
 
601
624
  ## ๐Ÿ“š Documentation
602
625
 
603
- - ๐Ÿ“– [Full Docs](https://sylphxltd.github.io/pdf-reader-mcp/) - Complete guides
626
+ - ๐Ÿ“– [Full Docs](https://SylphxAI.github.io/pdf-reader-mcp/) - Complete guides
604
627
  - ๐Ÿš€ [Getting Started](./docs/guide/getting-started.md) - Quick start
605
628
  - ๐Ÿ“˜ [API Reference](./docs/api/README.md) - Detailed API
606
629
  - ๐Ÿ—๏ธ [Design](./docs/design/index.md) - Architecture
@@ -618,7 +641,7 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
618
641
  - [x] Absolute paths (v1.3.0)
619
642
  - [x] 94%+ test coverage (v1.3.0)
620
643
 
621
- **๐Ÿš€ Coming Soon**
644
+ **๐Ÿš€ Next**
622
645
  - [ ] OCR for scanned PDFs
623
646
  - [ ] Annotation extraction
624
647
  - [ ] Form field extraction
@@ -627,19 +650,30 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
627
650
  - [ ] Advanced caching
628
651
  - [ ] PDF generation
629
652
 
630
- Vote at [Discussions](https://github.com/sylphxltd/pdf-reader-mcp/discussions)
653
+ Vote at [Discussions](https://github.com/SylphxAI/pdf-reader-mcp/discussions)
654
+
655
+ ---
656
+
657
+ ## ๐Ÿ† Recognition
658
+
659
+ **Featured on:**
660
+ - [Smithery](https://smithery.ai/server/@sylphx/pdf-reader-mcp) - MCP directory
661
+ - [Glama](https://glama.ai/mcp/servers/@sylphx/pdf-reader-mcp) - AI marketplace
662
+ - [MseeP.ai](https://mseep.ai/app/SylphxAI-pdf-reader-mcp) - Security validated
663
+
664
+ **Trusted worldwide** โ€ข **Enterprise adoption** โ€ข **Battle-tested**
631
665
 
632
666
  ---
633
667
 
634
668
  ## ๐Ÿค Support
635
669
 
636
- [![Issues](https://img.shields.io/github/issues/sylphxltd/pdf-reader-mcp?style=for-the-badge&logo=github)](https://github.com/sylphxltd/pdf-reader-mcp/issues)
637
- [![Discussions](https://img.shields.io/github/discussions/sylphxltd/pdf-reader-mcp?style=for-the-badge&logo=github)](https://github.com/sylphxltd/pdf-reader-mcp/discussions)
670
+ [![GitHub Issues](https://img.shields.io/github/issues/SylphxAI/pdf-reader-mcp?style=flat-square)](https://github.com/SylphxAI/pdf-reader-mcp/issues)
671
+ [![Discord](https://img.shields.io/discord/YOUR_DISCORD_ID?style=flat-square&logo=discord)](https://discord.gg/sylphx)
638
672
 
639
- - ๐Ÿ› [Bug Reports](https://github.com/sylphxltd/pdf-reader-mcp/issues)
640
- - ๐Ÿ’ฌ [Discussions](https://github.com/sylphxltd/pdf-reader-mcp/discussions)
641
- - ๐Ÿ“– [Contributing](./CONTRIBUTING.md)
642
- - ๐Ÿ“ง contact@sylphx.com
673
+ - ๐Ÿ› [Bug Reports](https://github.com/SylphxAI/pdf-reader-mcp/issues)
674
+ - ๐Ÿ’ฌ [Discussions](https://github.com/SylphxAI/pdf-reader-mcp/discussions)
675
+ - ๐Ÿ“– [Documentation](https://SylphxAI.github.io/pdf-reader-mcp/)
676
+ - ๐Ÿ“ง [Email](mailto:hi@sylphx.com)
643
677
 
644
678
  **Show Your Support:**
645
679
  โญ Star โ€ข ๐Ÿ‘€ Watch โ€ข ๐Ÿ› Report bugs โ€ข ๐Ÿ’ก Suggest features โ€ข ๐Ÿ”€ Contribute
@@ -648,40 +682,38 @@ Vote at [Discussions](https://github.com/sylphxltd/pdf-reader-mcp/discussions)
648
682
 
649
683
  ## ๐Ÿ“Š Stats
650
684
 
651
- ![Stars](https://img.shields.io/github/stars/sylphxltd/pdf-reader-mcp?style=social)
652
- ![Forks](https://img.shields.io/github/forks/sylphxltd/pdf-reader-mcp?style=social)
685
+ ![Stars](https://img.shields.io/github/stars/SylphxAI/pdf-reader-mcp?style=social)
686
+ ![Forks](https://img.shields.io/github/forks/SylphxAI/pdf-reader-mcp?style=social)
653
687
  ![Downloads](https://img.shields.io/npm/dm/@sylphx/pdf-reader-mcp)
654
- ![Contributors](https://img.shields.io/github/contributors/sylphxltd/pdf-reader-mcp)
688
+ ![Contributors](https://img.shields.io/github/contributors/SylphxAI/pdf-reader-mcp)
655
689
 
656
690
  **103 Tests** โ€ข **94%+ Coverage** โ€ข **Production Ready**
657
691
 
658
692
  ---
659
693
 
660
- ## ๐Ÿ† Recognition
661
-
662
- **Featured on:**
663
- - [Smithery](https://smithery.ai/server/@sylphx/pdf-reader-mcp) - MCP directory
664
- - [Glama](https://glama.ai/mcp/servers/@sylphx/pdf-reader-mcp) - AI marketplace
665
- - [MseeP.ai](https://mseep.ai/app/sylphxltd-pdf-reader-mcp) - Security validated
666
-
667
- **Trusted worldwide** โ€ข **Enterprise adoption** โ€ข **Battle-tested**
668
-
669
- ---
670
-
671
694
  ## ๐Ÿ“„ License
672
695
 
673
- MIT License - Free for personal and commercial use.
674
-
675
- See [LICENSE](./LICENSE) for details.
696
+ MIT ยฉ [Sylphx](https://sylphx.com)
676
697
 
677
698
  ---
678
699
 
679
- <div align="center">
700
+ ## ๐Ÿ™ Credits
680
701
 
681
- **Built with โค๏ธ by [Sylphx](https://sylphx.com)**
702
+ Built with:
703
+ - [PDF.js](https://mozilla.github.io/pdf.js/) - Mozilla PDF engine
704
+ - [MCP SDK](https://modelcontextprotocol.io) - Model Context Protocol
705
+ - [Vitest](https://vitest.dev) - Fast testing framework
682
706
 
683
- *Building the future of AI-powered document processing*
707
+ Special thanks to the open source community โค๏ธ
684
708
 
685
- [โฌ† Back to Top](#pdf-reader-mcp-)
709
+ ---
686
710
 
687
- </div>
711
+ <p align="center">
712
+ <strong>5-10x faster. Production-ready. Battle-tested.</strong>
713
+ <br>
714
+ <sub>The PDF processing server that actually scales</sub>
715
+ <br><br>
716
+ <a href="https://sylphx.com">sylphx.com</a> โ€ข
717
+ <a href="https://x.com/SylphxAI">@SylphxAI</a> โ€ข
718
+ <a href="mailto:hi@sylphx.com">hi@sylphx.com</a>
719
+ </p>