pdf-context
Provides optional local embeddings for document vectorization using Ollama's API, allowing offline or self-hosted embedding generation.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@pdf-context search for 'virtual memory' in operating-systems.pdf"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
PDF Context Server
PDF Context (pdf-context on PyPI, import pdf_context) is a local-first library and MCP server that transforms PDF documents into structured, retrievable context for AI applications.
Drop PDFs into a watch folder, and the server ingests them automatically — extracting structure, classifying document type, chunking with awareness of chapters/sections, embedding locally, and exposing retrieval tools that AI clients use to teach, answer questions, or navigate documents sequentially.
Drop in PDFs. Build context once. Query from anywhere.
Install
From PyPI (when published):
pip install pdf-contextFrom source (development):
git clone https://github.com/yourusername/pdf-context-server.git
cd pdf-context-server
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .envConsole entry points:
pdf-context— developer CLI (ingest, search, smoke tests)pdf-context-mcp— MCP stdio server for AI clients
Related MCP server: doc-index
Programmatic API
from pdf_context import PdfContext, PdfContextConfig
config = PdfContextConfig(
pdf_data_dir="/path/to/pdfs",
storage_dir="/path/to/storage",
)
ctx = PdfContext(config, watch=False)
ctx.ingest("my-book.pdf")
results = ctx.search("virtual memory", document="my-book.pdf", top_k=5)
print(results["chunks"])Each PdfContext instance is isolated: separate (pdf_dir, storage_dir) pairs get separate SQLite + Chroma indexes.
Features (v1)
PDF ingestion with folder watch and background job queue
Structure extraction from PDF outlines, heading heuristics, or page-level fallback
Auto document classification:
textbook,technical_reference,paper,notesPer-type retrieval profiles (chunk size, sequential vs semantic-first)
Local embeddings (sentence-transformers default, Ollama optional)
ChromaDB vector storage + SQLite metadata
Semantic search with structure filters (chapter, section, page range)
Sequential navigation for chapter-by-chapter learning
MCP stdio server for any compatible AI client
Production-grade local reliability: dedup, retries, checkpoints, resume
Architecture
PDF Documents (data/pdfs/)
│
▼
Folder Watcher ──► Job Queue (SQLite)
│
▼
Structure Extract + Classify + Parse + Chunk + Embed
│
├──► ChromaDB (vectors + metadata)
└──► SQLite (documents, structure, chunks, jobs)
│
▼
MCP Server (stdio)
├── NavigationalEngine (sequential / section content)
└── SemanticEngine (scoped semantic search)
│
▼
AI Client (Cursor, Claude Desktop, etc.)Project Structure
pdf-context-server/
├── pdf_context/ # installable package
│ ├── client.py # PdfContext public API
│ ├── config.py # PdfContextConfig
│ ├── context.py # AppContext runtime
│ ├── cli.py # pdf-context CLI
│ ├── mcp/ # MCP factory + stdio entry
│ ├── classification/
│ ├── structure/
│ ├── parsers/
│ ├── chunking.py
│ ├── embeddings.py
│ ├── vector_store.py
│ ├── db/
│ ├── ingest/
│ ├── retrieval/
│ └── skills/ # bundled agent skills (CLI install)
├── app/ # deprecated shim (python -m app.main)
├── .cursor/
│ ├── mcp.json # project MCP config (example)
│ └── skills/pdf-context/
├── data/pdfs/
├── storage/
├── tests/
├── pyproject.toml
├── requirements.txt # dev convenience (see pyproject.toml)
├── .env.example
└── README.mdInstallation (legacy dev clone)
See Install above. requirements.txt mirrors runtime deps; prefer pip install -e ".[dev]".
Quick test (no MCP required)
Drop a PDF in data/pdfs/, then run one command:
pdf-context smokeThat ingests all PDFs, runs a sample search, and prints PASS or FAIL with details.
Other useful commands:
pdf-context status
pdf-context list
pdf-context ingest
pdf-context ingest "my-book.pdf"
pdf-context search "virtual memory" -d "my-book.pdf"
pdf-context --pdf-dir /path/pdfs --storage-dir /path/storage status
pdf-context skill list
pdf-context skill install
pytestOr with Make: make smoke, make status, make test.
MCP is for daily use in Cursor. The CLI is for verifying everything works without configuring or reloading MCP.
Adding Documents
Place PDFs in your configured PDF folder (default data/pdfs/):
data/pdfs/
├── operating-systems.pdf
├── api-reference.pdf
└── lecture-notes.pdfKeep PDF and storage folders separate. pdf_data_dir and storage_dir must not be the same path, and neither may live inside the other. Mixing them causes the folder watcher to pick up Chroma/SQLite files, or ingest metadata into your PDF tree. Use sibling directories (defaults data/pdfs/ + storage/ are fine).
The folder watcher auto-enqueues new or changed PDFs for ingestion.
Optional type override sidecar:
data/pdfs/operating-systems.pdf.meta.json{ "doc_type": "textbook" }Valid types: textbook, technical_reference, paper, notes
MCP Setup
Enable pdf-context only in projects where PDFs are your source of truth. Avoid enabling it globally in Cursor user settings if most chats are code or general work—when the server is disconnected, the model cannot call PDF tools at all.
Add to project .cursor/mcp.json (Cursor) or your client's MCP config:
{
"mcpServers": {
"pdf-context": {
"command": "pdf-context-mcp",
"args": [
"--pdf-dir", "/absolute/path/to/pdfs",
"--storage-dir", "/absolute/path/to/storage"
]
}
}
}No repo clone required after pip install pdf-context. For local dev, point command at .venv/bin/pdf-context-mcp.
Legacy (deprecated): "command": "python", "args": ["-m", "app.main"]
Use a descriptive server name (pdf-context, pdf-ml-book, pdf-papers) so rules and skills can refer to the right corpus.
Restart or reload MCP after changing config.
Multiple corpora (research vs papers)
Run one MCP process per (pdf folder, storage) pair. Example:
{
"mcpServers": {
"pdf-textbooks": {
"command": "pdf-context-mcp",
"args": [
"--pdf-dir", "/Users/me/books",
"--storage-dir", "/Users/me/.pdf-context/books",
"--instance-id", "textbooks"
]
},
"pdf-papers": {
"command": "pdf-context-mcp",
"args": [
"--pdf-dir", "/Users/me/papers",
"--storage-dir", "/Users/me/.pdf-context/papers",
"--instance-id", "papers"
]
}
}
}Or via environment (PDF_CONTEXT_PDF_DATA_DIR, PDF_CONTEXT_STORAGE_DIR; legacy PDF_DATA_DIR / STORAGE_DIR still work):
"env": {
"PDF_CONTEXT_PDF_DATA_DIR": "/Users/me/books",
"PDF_CONTEXT_STORAGE_DIR": "/Users/me/.pdf-context/books"
}When the AI client should call MCP tools
The model chooses tools from your message, tool descriptions, and project skills—it is not automatic. This project steers that behavior in three layers:
Tool docstrings in
pdf_context/mcp/server.py— each tool states use when / do not use when.Project skill —
.cursor/skills/pdf-context/SKILL.mdtells Cursor when to use pdf-context vs codebase tools.Project-scoped MCP — enable the server only where PDFs matter.
User intent | Expected tools |
Fix code / git / tests | None (pdf-context idle) |
"What does the book say about X?" |
|
Chapter walkthrough with cites |
|
"Is my PDF indexed?" |
|
Casual chat | None |
Phrases that help: "From the indexed PDFs…", "Search [filename] for…", "Don't guess—use pdf-context."
Phrases that skip PDF tools: "In general (no PDF)", "Fix this Python file."
After pulling this repo, reload MCP so clients pick up new tool descriptions.
Install agent skill for any AI client
Bundled skills live in pdf_context/skills/. Install into Cursor, Claude Code, VS Code Copilot, Codex/AGENTS.md, Windsurf, Gemini, or a custom path:
pdf-context skill install
pdf-context skill list
pdf-context skill install -s pdf-context -c claude-code -p .
| Writes to |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| path from |
Markdown targets include marked blocks (<!-- pdf-context-skill:start/end -->) so re-running install can update the section without wiping your file.
MCP Tools
Tool | Purpose |
| Corpus check — what's indexed; call if unsure scope |
| Queue health; new PDFs; empty search debugging |
| Doc type, retrieval profile, per-document guidance |
| Full TOC tree |
| Flat chapter list (textbooks) |
| Ordered chunks for a chapter/section |
| Sequential read-ahead from cursor |
| Semantic search with optional structure filters |
| Override auto-classification (when user asks) |
| Force re-index (when user asks) |
Each tool's MCP description includes when to call it and when to skip it.
Document Types
Type | Treatment |
textbook | Sequential chapter navigation; larger chunks; chapter-scoped search |
technical_reference | Semantic-first; section-scoped search; no forced sequential reading |
paper | Section-scoped semantic search (abstract, methods, etc.) |
notes | Weak structure; semantic-only; page-level fallback navigation |
Classification is automatic at ingest. Override via .meta.json or set_document_type.
Chapter-by-Chapter Learning Workflow
The AI client holds progress via the cursor returned by navigational tools.
1. get_document_profile("operating-systems.pdf")
2. list_chapters("operating-systems.pdf")
3. get_section_content("operating-systems.pdf", node_id=<chapter_id>, limit=5)
4. [Client teaches / summarizes from returned chunks]
5. search_pdf_context("page faults", document="operating-systems.pdf", chapter_id=<id>)
6. get_next_chunks("operating-systems.pdf", cursor=<last_cursor>, limit=5)For unstructured notes, use list_structure and semantic search without sequential navigation.
Configuration
See .env.example. Key settings:
Variable | Default | Description |
|
| PDF watch folder (must not overlap storage) |
|
| SQLite + Chroma (must not overlap PDF folder) |
|
| or |
|
| Local embedding model |
|
| Auto-ingest on folder changes |
|
| Resume checkpoint during large ingests |
Legacy PDF_DATA_DIR / STORAGE_DIR (no prefix) are accepted for one release.
Path layout rule: After resolving to absolute paths, pdf_data_dir and storage_dir must differ and must not be nested (parent/child). Configuration is validated at startup when directories are created; invalid layouts raise a clear error.
First ingest of a large library (20+ textbooks, ~20k pages) on CPU may take hours. Checkpoints make ingestion resumable if interrupted.
Technology Stack
Python 3.11+
PyMuPDF — PDF parsing and outline extraction
sentence-transformers — local embeddings
ChromaDB — vector storage
SQLite — metadata, structure, job queue
MCP — AI client integration
watchdog — folder watching
Development
pip install -e ".[dev]"
pytest
pdf-context --help
pdf-context-mcp --helpVision
PDF Context Server converts static PDFs into structured, searchable knowledge that AI applications consume on demand — without re-uploading documents every session.
Retrieval, not synthesis: the server returns ranked chunks and structure metadata; your AI client generates answers, lessons, and summaries.
Available Tools
10 toolsget_document_profile_toolA
Get document type, retrieval profile, and how to query a specific PDF.
Use when starting work on a named document, when choosing between semantic search vs sequential reading, or when the user asks how a document is classified (textbook, paper, etc.).
Do not use for documents not in this server's index or for general ML/PDF advice unrelated to a specific ingested file.
Inputs: document (required). Returns: result
get_ingest_status_toolA
Get ingest queue status and health for this MCP server's index.
Use when search returns nothing, the user added new PDFs, ingestion may still be running, or they ask whether documents are ready. Check before assuming a document is missing from the corpus.
Do not use on every message—only when index readiness or failures matter.
Inputs: no named parameters. Returns: result
get_next_chunks_toolA
Read the next sequential chunks in an indexed PDF from a cursor.
Use after get_section_content or a prior get_next_chunks call to continue chapter-by-chapter or page-by-page reading. Pass cursor from the previous response's global_sequence_index.
Do not use for unrelated search queries; use search_pdf_context instead.
Inputs: document (required), cursor, limit. Returns: result
get_section_content_toolA
Get ordered text chunks for a chapter or section node in an indexed PDF.
Use for structured reading, teaching a section, or fetching passage text when node_id is known (from list_chapters or list_structure). Prefer over search when the user wants sequential content at a known location.
Do not use without a valid node_id from this document's structure tree.
Inputs: document (required), node_id (required), offset, limit. Returns: result
list_chapters_toolA
List chapters for an indexed PDF (primarily textbooks).
Use when the user asks about chapter numbers, chapter titles, chapter IDs, or page ranges at the chapter level. Pair with get_section_content for reading; note outline end_page may equal start_page—use get_next_chunks to read further.
Do not use for git branches, code modules, or non-PDF structure.
Inputs: document (required). Returns: result
list_documents_toolA
List PDFs indexed by this MCP server with type and structure summary.
Call first when unsure whether the user's question is about this corpus, when they ask what books/papers are available, or before search when no document name was given.
Do not use for listing files in the git repo or filesystem outside this server's ingested index.
Inputs: no named parameters. Returns: result
list_structure_toolA
Get the full table-of-contents / structure tree for an indexed PDF.
Use when the user needs the complete outline, section hierarchy, or node IDs for navigation—not just top-level chapters.
Do not use for repo directory trees or documents not in list_documents.
Inputs: document (required). Returns: result
reingest_document_toolA
Force re-index of a PDF in this server's corpus.
Use when the user explicitly requests re-ingest, after PDF file changes, or after set_document_type with reingest. Not for routine queries.
Do not use proactively or for code/build tasks.
Inputs: document (required). Returns: result
search_pdf_context_toolA
Semantic search over PDFs indexed by this MCP server only.
Use when the user asks for facts, quotes, definitions, or comparisons drawn from ingested PDFs; wants page citations; or names a document, chapter, or section in the corpus. Prefer chapter_id/section_id/page filters when scope is known.
Do not use for general world knowledge, repo/code tasks, git, or questions that do not require content from this server's PDF folder. If unsure whether the question is about indexed PDFs, call list_documents first.
Inputs: question (required), top_k, document, chapter_id, +5 more. Returns: result
set_document_type_toolA
Override auto-classified document type for an indexed PDF.
Use only when the user explicitly asks to change doc_type or when misclassification is confirmed and affects retrieval. Set reingest=true only if they want chunks re-built under the new profile.
Do not use proactively on every document or for repo configuration tasks.
Inputs: document (required), doc_type (required), reingest. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 10 tools
Each tool targets a distinct operation: document listing, chapter listing, structure browsing, sequential reading, semantic search, ingestion status, type management, re-ingest, and profile retrieval. No two tools have overlapping purposes; descriptions clearly delineate usage.
All tool names follow a consistent verb_noun_tool pattern (e.g., list_documents, get_section_content, search_pdf_context). Verbs are uniform (get, list, search, reingest, set), providing predictable navigation for an agent.
With 10 tools, the server covers all core PDF management operations—ingestion, navigation, search, and configuration—without overloading. The count feels appropriate for the domain and avoids unnecessary complexity.
The tool surface covers the essential lifecycle: list/search documents, navigate structure, read chunks, manage ingestion, and set document types. A minor gap is the lack of a delete/remove tool, but this is acceptable for a retrieval-focused server.
Maintenance
Related MCP Connectors
Hosted MCP server: convert PDFs to clean, LLM-ready Markdown with tables, formulas and OCR.
Query your own PDFs and documents from any MCP client. Every answer cites the page it came from.
Personal knowledge base MCP server with semantic search, auto-categorization, metadata extraction
Self-hosted AI workspace: semantic RAG document search, long-term memory, and AI chat via MCP.
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceA local-first MCP server that enables semantic search over PDF and DOCX documents using structure-aware parsing and vector storage. It allows users to query their local knowledge base through Claude Code without cloud dependencies or GPU requirements.1-
- AlicenseNot gradedqualityBmaintenanceA local-first semantic search server for documents, supporting PDFs, Office files, and text/markdown, enabling natural language search via the Model Context Protocol (MCP).1MIT
- FlicenseAqualityCmaintenanceMCP server that enables semantic search over local PDF collections using local RAG, with automatic indexing of new documents.5-
- FlicenseNot gradedqualityDmaintenanceA local MCP server that extracts text-layer content from PDF files, enabling AI agents to inspect, extract text, outlines, and page content.-